nitro-web 0.0.98 → 0.0.100

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nitro-web",
-  "version": "0.0.98",
+  "version": "0.0.100",
   "repository": "github:boycce/nitro-web",
   "homepage": "https://boycce.github.io/nitro-web/",
   "description": "Nitro is a battle-tested, modular base project to turbocharge your projects, styled using Tailwind 🚀",
@@ -55,7 +55,8 @@
     "tailwind-merge": "^2.6.0"
   },
   "devDependencies": {
-    "@types/dateformat": "^5.0.3"
+    "@types/dateformat": "^5.0.3",
+    "@typescript-eslint/eslint-plugin": "^8.18.1"
   },
   "peerDependencies": {
     "@stripe/stripe-js": "^1.34.0",

package/server/index.js

@@ -2,6 +2,11 @@
 export * from '../util.js'
 export * as util from '../util.js'
 
+/**
+ * Re-export the MiddlewareConfig type from nitro-web/server
+ * @typedef {import('./router.js').MiddlewareConfig} MiddlewareConfig
+ */
+
 // Export models
 import userModel from './models/user.js'
 import companyModel from './models/company.js'

package/server/router.js

@@ -12,9 +12,29 @@ import sortRouteAddressesNodeps from 'sort-route-addresses-nodeps'
 import { sendEmail } from 'nitro-web/server'
 import * as util from 'nitro-web/util'
 
+/**
+ * @typedef {express.Request & {
+ *   version: string,
+ *   user?: import('types').User,
+ * }} Request
+ * @typedef {express.Response & {
+ *   error: (msg?: string | Error | Error[], detail?: string) => void,
+ *   unauthorized: (msg?: string | Error | Error[]) => void,
+ *   forbidden: (msg?: string | Error | Error[]) => void,
+ *   notFound: (msg?: string | Error | Error[]) => void,
+ *   serverError: (msg?: string | Error | Error[]) => void,
+ * }} Response
+ * @typedef {{ 
+ *   order: string[], 
+ *   [key: string]: ((req: Request, res: Response, next: Function) => void) | string[],
+ * }} MiddlewareConfig
+ */
+
+let configLocal
 const _dirname = dirname(fileURLToPath(import.meta.url)) + '/'
 
 export async function setupRouter (config) {
+  configLocal = config
   const { env, middleware: configMiddleware, version } = config
   const { componentsDir, distDir, emailTemplateDir } = util.getDirectories(path, config.pwd)
   const expressApp = express()
@@ -53,8 +73,9 @@ export async function setupRouter (config) {
 
     if (routes?.setup) routes.setup.call(routes, allMiddleware, config)
     if (routes) {
-      util.each(routes, (_middleware, key) => {
-        if (!key.match(/\s/)) return
+      util.each(routes, (_middleware, _key) => {
+        if (!_key.match(/\s/)) return
+        const key = _key.replace(/\s+/g, ' ')
         const match = key.match(new RegExp(`^(${verbs.join('|')})\\s+(.*)$`, 'i'))
         if (!match) throw new Error(`Invalid verb or path: ${key}`)
         apiRoutes[key] = {
@@ -297,6 +318,7 @@ function resolveMiddleware (controllers, middleware, route, item) {
   }
 }
 
+/** @type {MiddlewareConfig} */
 export const middleware = {
   // Default middleware called before all /api/* routes
   order: [
@@ -350,39 +372,44 @@ export const middleware = {
 
   // --- Custom middleware ----------------------
 
+
   isAdmin: (req, res, next) => {
     // Still need to remove cookie matching in favour of uid..
     // E.g. Cookie matching handy for rare issues, e.g. signout > signin (to a different user on another tab)
     const user = req.user
-    let cookieMatch = user && (!req.headers.authid || user._id.toString() == req.headers.authid)
-    if (cookieMatch && (user.type?.match(/admin/) || user.isAdmin)) next()
+    let cookieMatch = user && (!req.headers.authid || user._id?.toString() == req.headers.authid)
+    if (cookieMatch && user && (user.type?.match(/admin/) || user.isAdmin)) next()
     else if (user && (user.type?.match(/admin/) || user.isAdmin)) res.unauthorized('Invalid cookie, please refresh your browser')
     else if (user) res.unauthorized('You are not authorised to make this request.')
     else res.unauthorized('Please sign in first.')
   },
-  isCompanyOwner: (req, res, next) => {
-    let user = req.user || { companies: [] }
-    let cid = req.params.cid
-    let company = user.companies.find((o) => o._id.toString() == cid)
-    let companyUser = company?.users?.find((o) => o._id.toString() == user._id.toString())
-    if (!user._id) return res.unauthorized('Please sign in first.')
-    else if (!company || !companyUser) res.unauthorized('You are not authorised to make this request.')
-    else if (companyUser.type != 'owner') res.unauthorized('Only owners can make this request.')
-    else next()
-  },
-  isCompanyUser: (req, res, next) => {
-    let user = req.user || { companies: [] }
-    let cid = req.params.cid
-    let company = user.companies.find((o) => o._id.toString() == cid)
-    if (!user._id) return res.unauthorized('Please sign in first.')
-    else if (!company) res.unauthorized('You are not authorised to make this request.')
-    else next()
-  },
+  // isCompanyOwner: (req, res, next) => {
+  //   let user = req.user || { companies: [] }
+  //   let cid = req.params.cid
+  //   let company = user.companies.find((o) => o._id.toString() == cid)
+  //   let companyUser = company?.users?.find((o) => o._id.toString() == user._id?.toString())
+  //   if (!user._id) return res.unauthorized('Please sign in first.')
+  //   else if (!company || !companyUser) res.unauthorized('You are not authorised to make this request.')
+  //   else if (companyUser.type != 'owner') res.unauthorized('Only owners can make this request.')
+  //   else next()
+  // },
+  // isCompanyUser: (req, res, next) => {
+  //   let user = req.user || { companies: [] }
+  //   let cid = req.params.cid
+  //   let company = user.companies.find((o) => o._id.toString() == cid)
+  //   if (!user._id) return res.unauthorized('Please sign in first.')
+  //   else if (!company) res.unauthorized('You are not authorised to make this request.')
+  //   else next()
+  // },
   isUser: (req, res, next) => {
     // todo: need to double check that uid is always defined
     let uid = req.params.uid
-    if (req.user && (typeof uid == 'undefined' || req.user._id.toString() == uid)) next()
+    if (req.user && (typeof uid == 'undefined' || req.user._id?.toString() == uid)) next()
     else if (req.user) res.unauthorized('You are not authorised to make this request.')
     else res.unauthorized('Please sign in first.')
   },
+  isDevelopment: (req, res, next) => {
+    if (configLocal.env !== 'development') res.error('This API endpoint is only available in development')
+    else next()
+  },
 }

package/types/server/index.d.ts

@@ -5,6 +5,10 @@ export * as util from "../util.js";
 export { sendEmail } from "./email/index.js";
 export { routes as authRoutes } from "../components/auth/auth.api.js";
 export { routes as stripeRoutes } from "../components/billing/stripe.api.js";
+/**
+ * Re-export the MiddlewareConfig type from nitro-web/server
+ */
+export type MiddlewareConfig = import("./router.js").MiddlewareConfig;
 import userModel from './models/user.js';
 import companyModel from './models/company.js';
 export function setupDefaultModels(db: any): Promise<void>;

package/types/server/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../server/index.js"],"names":[],"mappings":";;;;;;;sBAKsB,kBAAkB;yBACf,qBAAqB;AAC9C,2DAIC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../server/index.js"],"names":[],"mappings":";;;;;;;;;;+BAMa,OAAO,aAAa,EAAE,gBAAgB;sBAI7B,kBAAkB;yBACf,qBAAqB;AAC9C,2DAIC"}

package/types/server/router.d.ts

@@ -1,15 +1,21 @@
 export function setupRouter(config: any): Promise<http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>>;
-export namespace middleware {
-    let order: string[];
-    function modifyRequest(req: any, res: any, next: any): void;
-    let parseUrlEncoded: import("connect").NextHandleFunction;
-    let parseJson: import("connect").NextHandleFunction;
-    function parseFile(req: any, res: any, next: any): void;
-    function beforeAPIRoute(req: any, res: any, next: any): void;
-    function isAdmin(req: any, res: any, next: any): void;
-    function isCompanyOwner(req: any, res: any, next: any): any;
-    function isCompanyUser(req: any, res: any, next: any): any;
-    function isUser(req: any, res: any, next: any): void;
-}
+/** @type {MiddlewareConfig} */
+export const middleware: MiddlewareConfig;
+export type Request = express.Request & {
+    version: string;
+    user?: any;
+};
+export type Response = express.Response & {
+    error: (msg?: string | Error | Error[], detail?: string) => void;
+    unauthorized: (msg?: string | Error | Error[]) => void;
+    forbidden: (msg?: string | Error | Error[]) => void;
+    notFound: (msg?: string | Error | Error[]) => void;
+    serverError: (msg?: string | Error | Error[]) => void;
+};
+export type MiddlewareConfig = {
+    order: string[];
+    [key: string]: ((req: Request, res: Response, next: Function) => void) | string[];
+};
 import http from 'http';
+import express from 'express';
 //# sourceMappingURL=router.d.ts.map

package/types/server/router.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../server/router.js"],"names":[],"mappings":"AAgBA,wHA2HC;;;IA6KgB,4DAKd;;;IAoBU,wDAMV;IAEe,6DAGf;IAIQ,sDASR;IACe,4DASf;IACc,2DAOd;IACO,qDAMP;;iBA/Xc,MAAM"}
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../server/router.js"],"names":[],"mappings":"AAmCA,wHA6HC;AAgKD,+BAA+B;AAC/B,yBADW,gBAAgB,CA8F1B;sBA/YY,OAAO,CAAC,OAAO,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,GAAoB,CAAC;CAC7B;uBACS,OAAO,CAAC,QAAQ,GAAG;IAC3B,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACjE,YAAY,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,CAAC;IACvD,SAAS,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,CAAC;IACpD,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,CAAC;IACnD,WAAW,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,CAAC;CACvD;+BACS;IACR,KAAK,EAAE,MAAM,EAAE,CAAC;IACpB,CAAK,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,UAAU,KAAK,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC;CACnF;iBA1Ba,MAAM;oBAIH,SAAS"}

package/types.ts

@@ -30,6 +30,8 @@ export type User = {
   lastName?: string
   name?: string
   avatar?: MonasteryImage
+  isAdmin?: boolean
+  type?: string
 }
 
 export type Error = { title: string, detail: string }