@extk/expressive 0.7.1 → 0.9.0

package/dist/index.js

@@ -91,9 +91,6 @@ var SwaggerBuilder = class {
     this.swaggerDoc.security = globalAuthMethods;
     return this;
   }
-  get() {
-    return this.swaggerDoc;
-  }
 };
 var securitySchemes = {
   BasicAuth: () => ({
@@ -131,6 +128,22 @@ var security = (name) => {
   }
   return securityRegistry[name];
 };
+function singleFileSchema(field = "file", required = true) {
+  const schema = {
+    type: "object",
+    properties: {
+      [field]: { type: "string", format: "binary" }
+    },
+    ...required && { required: [field] }
+  };
+  return {
+    content: {
+      "multipart/form-data": {
+        schema
+      }
+    }
+  };
+}
 function formDataSchema(schema) {
   return {
     content: {
@@ -168,7 +181,7 @@ function queryParam(id, schema, required = true, description = "", name) {
   return param("query", id, schema, required, description, name);
 }
 function headerParam(id, schema, required = true, description = "", name) {
-  return param("headers", id, schema, required, description, name);
+  return param("header", id, schema, required, description, name);
 }
 function convertExpressPath(path2) {
   return path2.replace(/:([a-zA-Z0-9_*]+)/g, "{$1}");
@@ -188,17 +201,20 @@ var SWG = {
   formDataSchema,
   jsonSchema,
   jsonSchemaRef,
+  singleFileSchema,
   security,
   securitySchemes
 };
 
 // src/expressive.ts
 var ServerBuilder = class {
-  constructor(app, container) {
+  constructor(app, container, swaggerRef) {
     this.app = app;
     this.container = container;
+    this.swaggerRef = swaggerRef;
   }
   build() {
+    this.swaggerRef.doc = null;
     return this.app;
   }
   withHelmet(options) {
@@ -216,6 +232,7 @@ var ServerBuilder = class {
   withMorgan(format, options) {
     this.app.use((0, import_morgan.default)(
       format ?? ":req[x-real-ip] :method :url :status :res[content-length] - :response-time ms",
+      // TODO: ip or x-real-ip; also, default to json?
       options ?? { stream: { write: (message) => {
         this.container.logger.info(message.trim());
       } } }
@@ -233,18 +250,45 @@ var ServerBuilder = class {
     fn(this.app, this.container);
     return this;
   }
-  withSwagger(swagger, ...handlers) {
-    this.app.use(swagger.path ?? "/api-docs", ...handlers, import_swagger_ui_express.default.serve, import_swagger_ui_express.default.setup(swagger.config, {
-      customSiteTitle: swagger.config.info?.title
-    }));
+  withSwagger(configure, opts, ...handlers) {
+    const config = this.swaggerRef.doc;
+    if (!config) throw new Error("withSwagger must be called before build()");
+    configure(new SwaggerBuilder(config));
+    const { path: path2, uiOpts, options, customCss, customfavIcon, swaggerUrl, customSiteTitle } = opts;
+    const uiOptsWithDefaults = {
+      customSiteTitle: config.info?.title,
+      ...uiOpts
+    };
+    this.app.use(
+      path2,
+      ...handlers,
+      import_swagger_ui_express.default.serve,
+      import_swagger_ui_express.default.setup(
+        config,
+        uiOptsWithDefaults,
+        options,
+        customCss,
+        customfavIcon,
+        swaggerUrl,
+        customSiteTitle
+      )
+    );
     return this;
   }
 };
-function buildExpressive(container, swaggerDoc) {
+function buildExpressive(container) {
+  const swaggerRef = {
+    doc: {
+      openapi: "3.1.0",
+      info: {},
+      paths: {},
+      components: {}
+    }
+  };
   return {
     expressiveServer(configs) {
       const app = configs?.app ?? (0, import_express.default)();
-      return new ServerBuilder(app, container);
+      return new ServerBuilder(app, container, swaggerRef);
     },
     expressiveRouter(configs) {
       const router = import_express.default.Router();
@@ -287,10 +331,12 @@ function buildExpressive(container, swaggerDoc) {
           } else {
             pathItem.parameters.push(...tryParsePathParameters(route));
           }
-          if (!swaggerDoc.paths[route]) {
-            swaggerDoc.paths[route] = {};
+          if (swaggerRef.doc) {
+            if (!swaggerRef.doc.paths[route]) {
+              swaggerRef.doc.paths[route] = {};
+            }
+            swaggerRef.doc.paths[route][context.method] = pathItem;
           }
-          swaggerDoc.paths[route][context.method] = pathItem;
           return router;
         }
       };
@@ -528,17 +574,9 @@ var ApiResponse = class {
 
 // src/index.ts
 function bootstrap(container) {
-  const swaggerDoc = {
-    openapi: "3.1.0",
-    // TODO
-    info: {},
-    paths: {},
-    components: {}
-  };
   return {
-    ...buildExpressive(container, swaggerDoc),
+    ...buildExpressive(container),
     ...buildMiddleware(container),
-    swaggerBuilder: () => new SwaggerBuilder(swaggerDoc),
     silently: async (fn) => {
       try {
         await fn();

package/dist/index.mjs

@@ -30,9 +30,6 @@ var SwaggerBuilder = class {
     this.swaggerDoc.security = globalAuthMethods;
     return this;
   }
-  get() {
-    return this.swaggerDoc;
-  }
 };
 var securitySchemes = {
   BasicAuth: () => ({
@@ -70,6 +67,22 @@ var security = (name) => {
   }
   return securityRegistry[name];
 };
+function singleFileSchema(field = "file", required = true) {
+  const schema = {
+    type: "object",
+    properties: {
+      [field]: { type: "string", format: "binary" }
+    },
+    ...required && { required: [field] }
+  };
+  return {
+    content: {
+      "multipart/form-data": {
+        schema
+      }
+    }
+  };
+}
 function formDataSchema(schema) {
   return {
     content: {
@@ -107,7 +120,7 @@ function queryParam(id, schema, required = true, description = "", name) {
   return param("query", id, schema, required, description, name);
 }
 function headerParam(id, schema, required = true, description = "", name) {
-  return param("headers", id, schema, required, description, name);
+  return param("header", id, schema, required, description, name);
 }
 function convertExpressPath(path2) {
   return path2.replace(/:([a-zA-Z0-9_*]+)/g, "{$1}");
@@ -127,17 +140,20 @@ var SWG = {
   formDataSchema,
   jsonSchema,
   jsonSchemaRef,
+  singleFileSchema,
   security,
   securitySchemes
 };
 
 // src/expressive.ts
 var ServerBuilder = class {
-  constructor(app, container) {
+  constructor(app, container, swaggerRef) {
     this.app = app;
     this.container = container;
+    this.swaggerRef = swaggerRef;
   }
   build() {
+    this.swaggerRef.doc = null;
     return this.app;
   }
   withHelmet(options) {
@@ -155,6 +171,7 @@ var ServerBuilder = class {
   withMorgan(format, options) {
     this.app.use(morgan(
       format ?? ":req[x-real-ip] :method :url :status :res[content-length] - :response-time ms",
+      // TODO: ip or x-real-ip; also, default to json?
       options ?? { stream: { write: (message) => {
         this.container.logger.info(message.trim());
       } } }
@@ -172,18 +189,45 @@ var ServerBuilder = class {
     fn(this.app, this.container);
     return this;
   }
-  withSwagger(swagger, ...handlers) {
-    this.app.use(swagger.path ?? "/api-docs", ...handlers, swaggerUi.serve, swaggerUi.setup(swagger.config, {
-      customSiteTitle: swagger.config.info?.title
-    }));
+  withSwagger(configure, opts, ...handlers) {
+    const config = this.swaggerRef.doc;
+    if (!config) throw new Error("withSwagger must be called before build()");
+    configure(new SwaggerBuilder(config));
+    const { path: path2, uiOpts, options, customCss, customfavIcon, swaggerUrl, customSiteTitle } = opts;
+    const uiOptsWithDefaults = {
+      customSiteTitle: config.info?.title,
+      ...uiOpts
+    };
+    this.app.use(
+      path2,
+      ...handlers,
+      swaggerUi.serve,
+      swaggerUi.setup(
+        config,
+        uiOptsWithDefaults,
+        options,
+        customCss,
+        customfavIcon,
+        swaggerUrl,
+        customSiteTitle
+      )
+    );
     return this;
   }
 };
-function buildExpressive(container, swaggerDoc) {
+function buildExpressive(container) {
+  const swaggerRef = {
+    doc: {
+      openapi: "3.1.0",
+      info: {},
+      paths: {},
+      components: {}
+    }
+  };
   return {
     expressiveServer(configs) {
       const app = configs?.app ?? express();
-      return new ServerBuilder(app, container);
+      return new ServerBuilder(app, container, swaggerRef);
     },
     expressiveRouter(configs) {
       const router = express.Router();
@@ -226,10 +270,12 @@ function buildExpressive(container, swaggerDoc) {
           } else {
             pathItem.parameters.push(...tryParsePathParameters(route));
           }
-          if (!swaggerDoc.paths[route]) {
-            swaggerDoc.paths[route] = {};
+          if (swaggerRef.doc) {
+            if (!swaggerRef.doc.paths[route]) {
+              swaggerRef.doc.paths[route] = {};
+            }
+            swaggerRef.doc.paths[route][context.method] = pathItem;
           }
-          swaggerDoc.paths[route][context.method] = pathItem;
           return router;
         }
       };
@@ -467,17 +513,9 @@ var ApiResponse = class {
 
 // src/index.ts
 function bootstrap(container) {
-  const swaggerDoc = {
-    openapi: "3.1.0",
-    // TODO
-    info: {},
-    paths: {},
-    components: {}
-  };
   return {
-    ...buildExpressive(container, swaggerDoc),
+    ...buildExpressive(container),
     ...buildMiddleware(container),
-    swaggerBuilder: () => new SwaggerBuilder(swaggerDoc),
     silently: async (fn) => {
       try {
         await fn();

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@extk/expressive",
-    "version": "0.7.1",
+    "version": "0.9.0",
     "type": "commonjs",
     "publishConfig": {
         "access": "public"
@@ -25,7 +25,7 @@
         "lint": "eslint ./"
     },
     "devDependencies": {
-        "@extk/eslint-config": "^0.2.1",
+        "@extk/eslint-config": "^0.3.0",
         "@extk/tsconfig": "0.1.1",
         "@types/chance": "^1.1.7",
         "@types/express": "^5.0.1",
@@ -33,7 +33,7 @@
         "@types/node": "^20.9.3",
         "@types/swagger-ui-express": "^4.1.8",
         "chance": "^1.1.13",
-        "eslint": "^9.36.0",
+        "eslint": "^10.0.3",
         "tsup": "^8.5.0",
         "tsx": "^4.20.3",
         "typescript": "^5.9.2"