alien-middleware 0.7.1 → 0.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -24,9 +24,9 @@ type InputEnv<T extends MiddlewareChain> = Inputs<T>['env'];
24
24
  type Current<T extends MiddlewareChain> = T['$']['current'];
25
25
  type Properties<T extends MiddlewareChain> = Current<T>['properties'];
26
26
  type Env<T extends MiddlewareChain> = Current<T>['env'];
27
- type MiddlewareTypes<TProperties extends object = any, TEnv extends object = any> = {
28
- properties: TProperties;
27
+ type MiddlewareTypes<TEnv extends object = any, TProperties extends object = any> = {
29
28
  env: TEnv;
29
+ properties: TProperties;
30
30
  };
31
31
  interface HattipContext<TPlatform, TEnv extends object> extends AdapterRequestContext<TPlatform> {
32
32
  /**
@@ -48,13 +48,13 @@ type Intersectable<T extends object> = [T] extends [never] ? {} : [T] extends [A
48
48
  * should prefer `RequestContext<any>` over `RequestContext` (no type
49
49
  * parameters), as the default type is stricter.
50
50
  */
51
- type RequestContext<TProperties extends object = never, TEnv extends object = any, TPlatform = any> = HattipContext<TPlatform, TEnv> & Intersectable<TProperties>;
51
+ type RequestContext<TEnv extends object = any, TProperties extends object = never, TPlatform = any> = HattipContext<TPlatform, TEnv> & Intersectable<TProperties>;
52
52
  /**
53
53
  * Extract a `RequestContext` type from a `MiddlewareChain` type.
54
54
  *
55
55
  * When type `T` is `never`, a default context is returned.
56
56
  */
57
- type MiddlewareContext<T extends MiddlewareChain> = [T] extends [never] ? RequestContext<{}, {}, unknown> : RequestContext<Properties<T>, Env<T>, Platform<T>>;
57
+ type MiddlewareContext<T extends MiddlewareChain> = [T] extends [never] ? RequestContext<{}, never, unknown> : RequestContext<Env<T>, Properties<T>, Platform<T>>;
58
58
  type IsolatedContext<T extends MiddlewareChain> = RequestContext<InputProperties<T>, InputEnv<T>, Platform<T>>;
59
59
  type Awaitable<T> = T | Promise<T>;
60
60
  type RequestMiddleware<T extends MiddlewareChain = MiddlewareChain> = (context: RequestContext<InputProperties<T>, InputEnv<T>, Platform<T>>) => Awaitable<Response | RequestPlugin | void>;
@@ -67,34 +67,22 @@ type RequestHandler<TInputs extends MiddlewareTypes = any, TCurrent extends Midd
67
67
  * response middleware. This means it will run *after* a `Response` is generated
68
68
  * by a request middleware.
69
69
  */
70
- type Middleware<TProperties extends object = any, TEnv extends object = any, TPlatform = any> = (context: RequestContext<TProperties, TEnv, TPlatform>, response: Response) => Awaitable<Response | RequestPlugin | void>;
70
+ type Middleware<TEnv extends object = any, TProperties extends object = any, TPlatform = any> = (context: RequestContext<TEnv, TProperties, TPlatform>, response: Response) => Awaitable<Response | RequestPlugin | void>;
71
71
  /**
72
72
  * Extract a `Middleware` type from a `MiddlewareChain` type.
73
73
  */
74
- type ExtractMiddleware<T extends MiddlewareChain> = Middleware<Properties<T>, Env<T>, Platform<T>>;
74
+ type ExtractMiddleware<T extends MiddlewareChain> = Middleware<Env<T>, Properties<T>, Platform<T>>;
75
75
  type Merge<TSource extends object, TOverrides extends object | undefined> = {} & (TOverrides extends object ? {
76
76
  [K in keyof TSource | keyof TOverrides]: K extends keyof TOverrides ? TOverrides[K] : K extends keyof TSource ? TSource[K] : never;
77
77
  } : TSource);
78
- type ApplyRequestPlugin<TParent extends MiddlewareChain, TPlugin extends RequestPlugin> = {} & {
79
- properties: Merge<Properties<TParent>, Omit<TPlugin, keyof RequestEnvPlugin>>;
80
- env: Merge<Env<TParent>, TPlugin['env']>;
81
- };
78
+ type ApplyRequestPlugin<TParent extends MiddlewareChain, TPlugin extends RequestPlugin> = {} & MiddlewareTypes<Merge<Env<TParent>, TPlugin['env']>, Merge<Properties<TParent>, Omit<TPlugin, keyof RequestEnvPlugin>>>;
82
79
  /**
83
80
  * This applies a middleware to a chain. If the type `TMiddleware` is itself a
84
81
  * chain, it's treated as a nested chain, which won't leak its plugins into the
85
82
  * parent chain.
86
83
  */
87
- type ApplyMiddleware<TFirst extends MiddlewareChain, TSecond extends Middleware<Properties<TFirst>, Env<TFirst>, Platform<TFirst>>> = RequestHandler<Inputs<TFirst>, TSecond extends MiddlewareChain ? {
88
- properties: Merge<Properties<TFirst>, Properties<TSecond>>;
89
- env: Merge<Env<TFirst>, Env<TSecond>>;
90
- } : TSecond extends () => Awaitable<infer TResult> ? TResult extends RequestPlugin ? ApplyRequestPlugin<TFirst, TResult> : Current<TFirst> : Current<TFirst>, Platform<TFirst>>;
91
- type EmptyMiddlewareChain = MiddlewareChain<{
92
- properties: {};
93
- env: {};
94
- }, {
95
- properties: {};
96
- env: {};
97
- }, unknown>;
84
+ type ApplyMiddleware<TFirst extends MiddlewareChain, TSecond extends Middleware<Env<TFirst>, Properties<TFirst>, Platform<TFirst>>> = RequestHandler<Inputs<TFirst>, TSecond extends MiddlewareChain ? MiddlewareTypes<Merge<Env<TFirst>, Env<TSecond>>, Merge<Properties<TFirst>, Properties<TSecond>>> : TSecond extends () => Awaitable<infer TResult> ? TResult extends RequestPlugin ? ApplyRequestPlugin<TFirst, TResult> : Current<TFirst> : Current<TFirst>, Platform<TFirst>>;
85
+ type EmptyMiddlewareChain = MiddlewareChain<MiddlewareTypes<{}, {}>, MiddlewareTypes<{}, {}>, unknown>;
98
86
  type ApplyFirstMiddleware<T extends Middleware> = T extends MiddlewareChain ? T : ApplyMiddleware<EmptyMiddlewareChain, T>;
99
87
  type RouteMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS' | 'HEAD';
100
88
  type RouterContext<T extends MiddlewareChain = any, TPathParams extends object = any, TMethod extends RouteMethod = RouteMethod> = MiddlewareContext<T> & {
@@ -139,13 +127,7 @@ TPlatform = any> {
139
127
  */
140
128
  isolate(): ((ctx: IsolatedContext<this>) => Promise<Response | void>) | typeof noop;
141
129
  }
142
- declare function chain<TProperties extends object = {}, TEnv extends object = {}, TPlatform = unknown>(): MiddlewareChain<{
143
- env: TEnv;
144
- properties: TProperties;
145
- }, {
146
- env: TEnv;
147
- properties: TProperties;
148
- }, TPlatform>;
130
+ declare function chain<TEnv extends object = {}, TProperties extends object = {}, TPlatform = unknown>(): MiddlewareChain<MiddlewareTypes<TEnv, TProperties>, MiddlewareTypes<TEnv, TProperties>, TPlatform>;
149
131
  declare function chain<const T extends Middleware = Middleware>(middleware: T): ApplyFirstMiddleware<T>;
150
132
 
151
133
  export { type ApplyMiddleware as A, type EmptyMiddlewareChain as E, MiddlewareChain as M, type RouteHandler as R, type MiddlewareContext as a, type RouteMethod as b, type RouterContext as c, chain as d, type ExtractMiddleware as e, type Middleware as f, type RequestContext as g, type RequestHandler as h, type RequestMiddleware as i, type RequestPlugin as j, type ResponseMiddleware as k };
package/dist/index.d.ts CHANGED
@@ -1,3 +1,3 @@
1
1
  import 'radashi';
2
- export { A as ApplyMiddleware, e as ExtractMiddleware, f as Middleware, M as MiddlewareChain, a as MiddlewareContext, g as RequestContext, h as RequestHandler, i as RequestMiddleware, j as RequestPlugin, k as ResponseMiddleware, d as chain } from './index-DEMeaByn.js';
2
+ export { A as ApplyMiddleware, e as ExtractMiddleware, f as Middleware, M as MiddlewareChain, a as MiddlewareContext, g as RequestContext, h as RequestHandler, i as RequestMiddleware, j as RequestPlugin, k as ResponseMiddleware, d as chain } from './index-BP2sjKus.js';
3
3
  import '@hattip/core';
package/dist/router.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { InferParams } from 'pathic';
2
- import { M as MiddlewareChain, E as EmptyMiddlewareChain, a as MiddlewareContext, R as RouteHandler, b as RouteMethod } from './index-DEMeaByn.js';
3
- export { c as RouterContext } from './index-DEMeaByn.js';
2
+ import { M as MiddlewareChain, E as EmptyMiddlewareChain, a as MiddlewareContext, R as RouteHandler, b as RouteMethod } from './index-BP2sjKus.js';
3
+ export { c as RouterContext } from './index-BP2sjKus.js';
4
4
  import 'radashi';
5
5
  import '@hattip/core';
6
6
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "alien-middleware",
3
3
  "type": "module",
4
- "version": "0.7.1",
4
+ "version": "0.8.1",
5
5
  "exports": {
6
6
  ".": {
7
7
  "types": "./dist/index.d.ts",
package/readme.md CHANGED
@@ -121,7 +121,7 @@ Request middleware runs sequentially before a `Response` is generated.
121
121
  return { user }
122
122
  }
123
123
 
124
- const greetUser = (context: RequestContext<{ user: User }>) => {
124
+ const greetUser = (context: RequestContext<{}, { user: User }>) => {
125
125
  // The `user` property is now available thanks to `addUser`
126
126
  return new Response(`Hello, ${context.user.name}!`)
127
127
  }
@@ -138,7 +138,7 @@ Request middleware runs sequentially before a `Response` is generated.
138
138
  return { env: { API_KEY: 'secret123' } }
139
139
  }
140
140
 
141
- const useApiKey = (context: RequestContext<never, { API_KEY: string }>) => {
141
+ const useApiKey = (context: RequestContext<{ API_KEY: string }>) => {
142
142
  const key = context.env('API_KEY')
143
143
  console.log('API Key:', key) // Output: API Key: secret123
144
144
  }
@@ -267,7 +267,7 @@ type Env = {
267
267
  API_KEY: string
268
268
  }
269
269
 
270
- const app = chain<any, Env>().use(context => {
270
+ const app = chain<Env>().use(context => {
271
271
  const key = context.env('API_KEY')
272
272
  // ^? string
273
273
  })
@@ -279,7 +279,7 @@ When defining a middleware, you can declare env types that the middleware expect
279
279
  import type { RequestContext } from 'alien-middleware'
280
280
 
281
281
  // Assuming `Env` is defined like in the previous example.
282
- const myMiddleware = (context: RequestContext<any, Env>) => {
282
+ const myMiddleware = (context: RequestContext<Env>) => {
283
283
  const key = context.env('API_KEY')
284
284
  }
285
285
  ```