express-zod-api 30.0.0-beta.2 → 30.0.0

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.
Files changed (2) hide show
  1. package/dist/index.js +1 -1
  2. package/package.json +3 -3
package/dist/index.js CHANGED
@@ -3,4 +3,4 @@ import{A as e,B as t,C as n,D as r,E as i,H as a,L as o,M as s,O as c,P as l,Q a
3
3
  `+i.join(`
4
4
  `)+`
5
5
 
6
- `)},$=e=>{e.startupLogo!==!1&&pt(process.stdout);let t=e.errorHandler||N,n=Ve(e.logger)?e.logger:new q(e.logger);n.debug(`Running`,{build:`v30.0.0-beta.2`,env:u.env}),u.isProduction&&n instanceof q&&n.warn(`Using the built-in logger in production may degrade performance due to synchronous printing. Consider installing a professional logging solution, such as Pino or Winston.`),dt(n);let r=ct({logger:n,config:e}),i={getLogger:lt(n),errorHandler:t},a=tt(i),o=et(i);return{...i,logger:n,notFoundHandler:a,catcher:o,loggingMiddleware:r}},mt=(e,t)=>{let{logger:n,getLogger:r,notFoundHandler:i,loggingMiddleware:a}=$(e),o=e.app.use(a);return e.cors&&o.use(it(e.cors)),Y({app:o,routing:t,getLogger:r,config:e}),{notFoundHandler:i,logger:n}},ht=(e,t)=>{let{logger:n,getLogger:r,notFoundHandler:i,catcher:a,loggingMiddleware:o}=$(e),s=j().disable(`x-powered-by`).set(`query parser`,e.queryParser??`simple`).use(o);if(e.beforeParsers?.({app:s,getLogger:r}),e.compression){let t=T(`compression`);s.use(t(typeof e.compression==`object`?e.compression:void 0))}return e.cookies&&s.use(rt({config:e})),e.cors&&s.use(it(e.cors)),s.use(e.jsonParser||j.json()).use(e.formParser||j.urlencoded()).use(e.rawParser||j.raw(),st),e.upload&&s.use(...ot({config:e,getLogger:r})),e.beforeRouting?.({app:s,getLogger:r}),Y({app:s,routing:t,getLogger:r,config:e}),e.afterRouting?.({app:s,getLogger:r}),s.use(a,i),{app:s,logger:n}},gt=(e,t)=>{let{app:n,logger:r}=ht(e,t),i=[],a=(e,t)=>()=>e.listen(t,()=>r.info(`Listening`,t)),o=[];if(e.http){let t=Te.createServer(n);i.push(t),o.push(a(t,e.http.listen))}if(e.https){let t=Ee.createServer(e.https.options,n);i.push(t),o.push(a(t,e.https.listen))}return i.length||r.warn(`No servers configured.`),e.gracefulShutdown&&ft({logger:r,servers:i,options:e.gracefulShutdown===!0?{}:e.gracefulShutdown}),{app:n,logger:r,servers:o.map(e=>e())}},_t=e=>Oe({...e,headers:{"content-type":b.json,...e?.headers}}),vt=e=>ke(e),yt=e=>{let t={warn:[],error:[],info:[],debug:[]};return new Proxy(e||{},{get(e,n,r){return n===`_getLogs`?()=>t:G(n)?(...e)=>t[n].push(e):Reflect.get(e,n,r)},has(e,t){return G(t)||t===`_getLogs`?!0:Reflect.has(e,t)}})},bt=({requestProps:e,responseOptions:t,configProps:n,loggerProps:r})=>{let i=_t(e),a=vt({req:i,...t});a.req=t?.req||i,i.res=a;let o=yt(r);return{requestMock:i,responseMock:a,loggerMock:o,configMock:{cors:!1,logger:o,...n}}},xt=async({endpoint:e,...t})=>{let{requestMock:n,responseMock:r,loggerMock:i,configMock:a}=bt(t);return await e.execute({request:n,response:r,config:a,logger:i}),{requestMock:n,responseMock:r,loggerMock:i}},St=async({middleware:e,ctx:t={},...n})=>{let{configMock:r,...i}=bt(n),{inputSources:o,errorHandler:s=N}=r,c=a(i.requestMock,o),l={request:i.requestMock,response:i.responseMock,logger:i.loggerMock,input:c,ctx:t};try{let t=await e.execute({...l,config:r});return{...i,output:t}}catch(e){return await s.execute({...l,error:p(e),output:null}),{...i,output:{}}}},Ct=(e,t)=>D.object({data:t,event:D.literal(e),id:D.string().optional(),retry:D.int().positive().optional()}),wt=/[\r\n\0]/g,Tt=({events:e,event:t,data:n,id:r,retry:i})=>{if(!Object.prototype.hasOwnProperty.call(e,t))throw Error(`Unknown event: ${t}`);let a=e[t].parse(n),o=`event: ${t}\n`;return r!==void 0&&(o+=`id: ${r}\n`),i!==void 0&&(o+=`retry: ${i}\n`),o+`data: ${JSON.stringify(a)}\n\n`},Et=e=>e.headersSent||e.writeHead(200,{connection:`keep-alive`,"content-type":b.sse,"cache-control":`no-cache`}),Dt=(e,{eventId:t=!1,retry:n}={})=>{let r=0,i;if(n!==void 0&&!(Number.isInteger(n)&&n>0))throw Error(`Invalid SSE retry value "${n}": must be a positive integer.`);return t&&(i=typeof t==`function`?(e,n)=>t(e,n).replace(wt,``):(e,t)=>`${e}##${t}`),new _({handler:async({request:t,response:a})=>{let o=new AbortController,s=setTimeout(()=>Et(a),1e4);return t.once(`close`,()=>{clearTimeout(s),o.abort()}),{isClosed:()=>a.writableEnded||a.closed,signal:o.signal,lastEventId:i&&t.get(`last-event-id`),emit:(t,o)=>{Et(a);let s=Tt({events:e,data:o,retry:n,id:i&&i(String(t),++r),event:String(t)});a.write(s,`utf-8`),a.flush?.()}}}})},Ot=e=>new M({positive:()=>{let[t,...n]=Object.entries(e).map(([e,t])=>Ct(e,t));if(!t)throw new c(/* @__PURE__ */ Error(`At least one SSE event is required.`));return{mimeType:b.sse,schema:n.length?D.discriminatedUnion(`event`,[t,...n]):t}},negative:{mimeType:`text/plain`,schema:D.string()},handler:async({response:e,error:t,logger:n,request:r,input:i})=>{if(t){let a=x(t);v(a,n,r,i),e.headersSent||e.status(a.statusCode).type(`text/plain`).write(m(a),`utf-8`)}e.end()}});var kt=class extends H{constructor(e,t){let n=Object.fromEntries(Object.entries(e).map(([e,t])=>{if(e.match(wt))throw Error(`Invalid SSE event name "${e}": must not contain line breaks or null characters.`);return[e,w(t)]}));super(Ot(n)),this.middlewares=[Dt(n,t)]}};const At=[`total`,`limit`,`offset`],jt=[`nextCursor`,`limit`];function Mt({style:e,itemSchema:t,itemsName:n=`items`,maxLimit:r=100,defaultLimit:i=20}){if(!Number.isInteger(r)||r<1)throw Error(`ez.paginated: maxLimit must be a positive integer`);if(!Number.isInteger(i)||i<1)throw Error(`ez.paginated: defaultLimit must be a positive integer`);if(i>r)throw Error(`ez.paginated: defaultLimit must not be greater than maxLimit`);if(e===`offset`&&At.includes(n))throw Error(`ez.paginated: itemsName must not match reserved keys for offset output (${At.join(`, `)})`);if(e===`cursor`&&jt.includes(n))throw Error(`ez.paginated: itemsName must not match reserved keys for cursor output (${jt.join(`, `)})`);let a=D.coerce.number().int().min(1).max(r).default(i).describe(`Page size (number of ${n} per page)`);if(e===`offset`){let e=D.coerce.number().int().min(0).default(0).describe(`Number of ${n} to skip`);return{input:D.object({limit:a,offset:e}),output:D.object({[n]:D.array(t).describe(`Page of ${n}`),total:D.number().int().min(0).describe(`Total number of ${n}`),limit:D.number().int().min(1).describe(`Page size used`),offset:D.number().int().min(0).describe(`Offset used`)})}}let o=D.string().optional().describe(`Cursor for the next page; omit for first page`);return{input:D.object({cursor:o,limit:a}),output:D.object({[n]:D.array(t).describe(`Page of ${n}`),nextCursor:D.string().nullable().describe(`Cursor for the next page, or null if no more pages`),limit:D.number().int().min(1).describe(`Page size used`)})}}const Nt={dateIn:s,dateOut:e,form:te,upload:n,raw:ue,buffer:l,paginated:Mt};export{q as BuiltinLogger,H as EndpointsFactory,kt as EventStreamFactory,d as InputValidationError,_ as Middleware,i as MissingPeerError,r as OutputValidationError,M as ResultHandler,ie as RoutingError,ne as ServeStatic,Be as arrayEndpointsFactory,L as arrayResultHandler,mt as attachRouting,re as createApiResponse,z as createCacheMiddleware,Ae as createConfig,B as createCookieMiddleware,V as createRateLimitMiddleware,gt as createServer,Re as defaultEndpointsFactory,N as defaultResultHandler,x as ensureHttpError,Nt as ez,ee as getMessageFromError,ze as legacyEndpointsFactory,F as legacyResultHandler,xt as testEndpoint,St as testMiddleware};
6
+ `)},$=e=>{e.startupLogo!==!1&&pt(process.stdout);let t=e.errorHandler||N,n=Ve(e.logger)?e.logger:new q(e.logger);n.debug(`Running`,{build:`v30.0.0`,env:u.env}),u.isProduction&&n instanceof q&&n.warn(`Using the built-in logger in production may degrade performance due to synchronous printing. Consider installing a professional logging solution, such as Pino or Winston.`),dt(n);let r=ct({logger:n,config:e}),i={getLogger:lt(n),errorHandler:t},a=tt(i),o=et(i);return{...i,logger:n,notFoundHandler:a,catcher:o,loggingMiddleware:r}},mt=(e,t)=>{let{logger:n,getLogger:r,notFoundHandler:i,loggingMiddleware:a}=$(e),o=e.app.use(a);return e.cors&&o.use(it(e.cors)),Y({app:o,routing:t,getLogger:r,config:e}),{notFoundHandler:i,logger:n}},ht=(e,t)=>{let{logger:n,getLogger:r,notFoundHandler:i,catcher:a,loggingMiddleware:o}=$(e),s=j().disable(`x-powered-by`).set(`query parser`,e.queryParser??`simple`).use(o);if(e.beforeParsers?.({app:s,getLogger:r}),e.compression){let t=T(`compression`);s.use(t(typeof e.compression==`object`?e.compression:void 0))}return e.cookies&&s.use(rt({config:e})),e.cors&&s.use(it(e.cors)),s.use(e.jsonParser||j.json()).use(e.formParser||j.urlencoded()).use(e.rawParser||j.raw(),st),e.upload&&s.use(...ot({config:e,getLogger:r})),e.beforeRouting?.({app:s,getLogger:r}),Y({app:s,routing:t,getLogger:r,config:e}),e.afterRouting?.({app:s,getLogger:r}),s.use(a,i),{app:s,logger:n}},gt=(e,t)=>{let{app:n,logger:r}=ht(e,t),i=[],a=(e,t)=>()=>e.listen(t,()=>r.info(`Listening`,t)),o=[];if(e.http){let t=Te.createServer(n);i.push(t),o.push(a(t,e.http.listen))}if(e.https){let t=Ee.createServer(e.https.options,n);i.push(t),o.push(a(t,e.https.listen))}return i.length||r.warn(`No servers configured.`),e.gracefulShutdown&&ft({logger:r,servers:i,options:e.gracefulShutdown===!0?{}:e.gracefulShutdown}),{app:n,logger:r,servers:o.map(e=>e())}},_t=e=>Oe({...e,headers:{"content-type":b.json,...e?.headers}}),vt=e=>ke(e),yt=e=>{let t={warn:[],error:[],info:[],debug:[]};return new Proxy(e||{},{get(e,n,r){return n===`_getLogs`?()=>t:G(n)?(...e)=>t[n].push(e):Reflect.get(e,n,r)},has(e,t){return G(t)||t===`_getLogs`?!0:Reflect.has(e,t)}})},bt=({requestProps:e,responseOptions:t,configProps:n,loggerProps:r})=>{let i=_t(e),a=vt({req:i,...t});a.req=t?.req||i,i.res=a;let o=yt(r);return{requestMock:i,responseMock:a,loggerMock:o,configMock:{cors:!1,logger:o,...n}}},xt=async({endpoint:e,...t})=>{let{requestMock:n,responseMock:r,loggerMock:i,configMock:a}=bt(t);return await e.execute({request:n,response:r,config:a,logger:i}),{requestMock:n,responseMock:r,loggerMock:i}},St=async({middleware:e,ctx:t={},...n})=>{let{configMock:r,...i}=bt(n),{inputSources:o,errorHandler:s=N}=r,c=a(i.requestMock,o),l={request:i.requestMock,response:i.responseMock,logger:i.loggerMock,input:c,ctx:t};try{let t=await e.execute({...l,config:r});return{...i,output:t}}catch(e){return await s.execute({...l,error:p(e),output:null}),{...i,output:{}}}},Ct=(e,t)=>D.object({data:t,event:D.literal(e),id:D.string().optional(),retry:D.int().positive().optional()}),wt=/[\r\n\0]/g,Tt=({events:e,event:t,data:n,id:r,retry:i})=>{if(!Object.prototype.hasOwnProperty.call(e,t))throw Error(`Unknown event: ${t}`);let a=e[t].parse(n),o=`event: ${t}\n`;return r!==void 0&&(o+=`id: ${r}\n`),i!==void 0&&(o+=`retry: ${i}\n`),o+`data: ${JSON.stringify(a)}\n\n`},Et=e=>e.headersSent||e.writeHead(200,{connection:`keep-alive`,"content-type":b.sse,"cache-control":`no-cache`}),Dt=(e,{eventId:t=!1,retry:n}={})=>{let r=0,i;if(n!==void 0&&!(Number.isInteger(n)&&n>0))throw Error(`Invalid SSE retry value "${n}": must be a positive integer.`);return t&&(i=typeof t==`function`?(e,n)=>t(e,n).replace(wt,``):(e,t)=>`${e}##${t}`),new _({handler:async({request:t,response:a})=>{let o=new AbortController,s=setTimeout(()=>Et(a),1e4);return t.once(`close`,()=>{clearTimeout(s),o.abort()}),{isClosed:()=>a.writableEnded||a.closed,signal:o.signal,lastEventId:i&&t.get(`last-event-id`),emit:(t,o)=>{Et(a);let s=Tt({events:e,data:o,retry:n,id:i&&i(String(t),++r),event:String(t)});a.write(s,`utf-8`),a.flush?.()}}}})},Ot=e=>new M({positive:()=>{let[t,...n]=Object.entries(e).map(([e,t])=>Ct(e,t));if(!t)throw new c(/* @__PURE__ */ Error(`At least one SSE event is required.`));return{mimeType:b.sse,schema:n.length?D.discriminatedUnion(`event`,[t,...n]):t}},negative:{mimeType:`text/plain`,schema:D.string()},handler:async({response:e,error:t,logger:n,request:r,input:i})=>{if(t){let a=x(t);v(a,n,r,i),e.headersSent||e.status(a.statusCode).type(`text/plain`).write(m(a),`utf-8`)}e.end()}});var kt=class extends H{constructor(e,t){let n=Object.fromEntries(Object.entries(e).map(([e,t])=>{if(e.match(wt))throw Error(`Invalid SSE event name "${e}": must not contain line breaks or null characters.`);return[e,w(t)]}));super(Ot(n)),this.middlewares=[Dt(n,t)]}};const At=[`total`,`limit`,`offset`],jt=[`nextCursor`,`limit`];function Mt({style:e,itemSchema:t,itemsName:n=`items`,maxLimit:r=100,defaultLimit:i=20}){if(!Number.isInteger(r)||r<1)throw Error(`ez.paginated: maxLimit must be a positive integer`);if(!Number.isInteger(i)||i<1)throw Error(`ez.paginated: defaultLimit must be a positive integer`);if(i>r)throw Error(`ez.paginated: defaultLimit must not be greater than maxLimit`);if(e===`offset`&&At.includes(n))throw Error(`ez.paginated: itemsName must not match reserved keys for offset output (${At.join(`, `)})`);if(e===`cursor`&&jt.includes(n))throw Error(`ez.paginated: itemsName must not match reserved keys for cursor output (${jt.join(`, `)})`);let a=D.coerce.number().int().min(1).max(r).default(i).describe(`Page size (number of ${n} per page)`);if(e===`offset`){let e=D.coerce.number().int().min(0).default(0).describe(`Number of ${n} to skip`);return{input:D.object({limit:a,offset:e}),output:D.object({[n]:D.array(t).describe(`Page of ${n}`),total:D.number().int().min(0).describe(`Total number of ${n}`),limit:D.number().int().min(1).describe(`Page size used`),offset:D.number().int().min(0).describe(`Offset used`)})}}let o=D.string().optional().describe(`Cursor for the next page; omit for first page`);return{input:D.object({cursor:o,limit:a}),output:D.object({[n]:D.array(t).describe(`Page of ${n}`),nextCursor:D.string().nullable().describe(`Cursor for the next page, or null if no more pages`),limit:D.number().int().min(1).describe(`Page size used`)})}}const Nt={dateIn:s,dateOut:e,form:te,upload:n,raw:ue,buffer:l,paginated:Mt};export{q as BuiltinLogger,H as EndpointsFactory,kt as EventStreamFactory,d as InputValidationError,_ as Middleware,i as MissingPeerError,r as OutputValidationError,M as ResultHandler,ie as RoutingError,ne as ServeStatic,Be as arrayEndpointsFactory,L as arrayResultHandler,mt as attachRouting,re as createApiResponse,z as createCacheMiddleware,Ae as createConfig,B as createCookieMiddleware,V as createRateLimitMiddleware,gt as createServer,Re as defaultEndpointsFactory,N as defaultResultHandler,x as ensureHttpError,Nt as ez,ee as getMessageFromError,ze as legacyEndpointsFactory,F as legacyResultHandler,xt as testEndpoint,St as testMiddleware};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "express-zod-api",
3
- "version": "30.0.0-beta.2",
3
+ "version": "30.0.0",
4
4
  "description": "A Typescript framework to help you get an API server up and running with I/O schema validation and custom middlewares in minutes.",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -51,7 +51,7 @@
51
51
  "ramda": "^0.32.0"
52
52
  },
53
53
  "peerDependencies": {
54
- "@express-zod-api/zod-plugin": "^7.0.0-beta.1",
54
+ "@express-zod-api/zod-plugin": "^7.0.0",
55
55
  "@types/compression": "^1.7.5",
56
56
  "@types/cookie-parser": "^1.4.10",
57
57
  "@types/express": "^5.0.6",
@@ -102,7 +102,7 @@
102
102
  }
103
103
  },
104
104
  "devDependencies": {
105
- "@express-zod-api/zod-plugin": "^7.0.0-beta.1",
105
+ "@express-zod-api/zod-plugin": "^7.0.0",
106
106
  "@types/compression": "^1.8.1",
107
107
  "@types/cookie-parser": "^1.4.10",
108
108
  "@types/cors": "^2.8.19",