@extk/expressive 0.2.1 → 0.3.0

package/dist/index.d.mts

@@ -34,9 +34,61 @@ type Container = {
     alertHandler?: AlertHandler;
 };
 
-type Schema = Record<string, unknown> | {
+type NumericConfigs = {
+    minimum?: number;
+    maximum?: number;
+    exclusiveMinimum?: boolean;
+    exclusiveMaximum?: boolean;
+    multipleOf?: number;
+};
+type NumberType = {
+    type: 'number';
+    format?: 'float' | 'double';
+} & NumericConfigs;
+type IntegerType = {
+    type: 'integer';
+    format?: 'int32' | 'int64';
+} & NumericConfigs;
+type StringType = {
+    type: 'string';
+    minLength?: number;
+    maxLength?: number;
+    format?: 'date' | 'date-time' | 'password' | 'byte' | 'binary' | 'email' | 'uuid' | 'uri' | 'hostname' | 'ipv4' | 'ipv6';
+    pattern?: string;
+};
+type BooleanType = {
+    type: 'boolean';
+};
+type ArrayType = {
+    type: 'array';
+    items: Partial<Schema>;
+    minItems?: number;
+    maxItems?: number;
+    uniqueItems?: boolean;
+};
+type ObjectType = {
+    type: 'object';
+    properties?: Record<string, Schema>;
+    required?: string[];
+    additionalProperties?: boolean | Schema;
+    minProperties?: number;
+    maxProperties?: number;
+};
+type BaseSchema = ({
+    nullable?: boolean;
+    enum?: unknown[];
+    description?: string;
+    default?: unknown;
+} & (StringType | NumberType | IntegerType | BooleanType | ArrayType | ObjectType)) | {
     $ref: string;
 };
+type Schema = BaseSchema | {
+    allOf: BaseSchema[];
+} | {
+    anyOf: BaseSchema[];
+} | {
+    oneOf: BaseSchema[];
+};
 type Content = {
     description?: string;
     content?: Partial<Record<ContentType, {
@@ -46,7 +98,7 @@ type Content = {
 type Param = {
     in: 'path' | 'query' | 'headers';
     name: string;
-    desciption: string;
+    description: string;
     required: boolean;
     schema: Schema;
 };
@@ -225,19 +277,23 @@ declare function bootstrap(container: Container): {
         get(): SwaggerConfig;
     };
     expressiveServer(configs: {
-        swagger: {
-            path: ExpressRoute;
+        app?: express.Express;
+    }): {
+        get(): express.Express;
+        withHelmet(options?: Readonly<helmet.HelmetOptions>): /*elided*/ any;
+        withQs(): /*elided*/ any;
+        withMorgan(format?: string, options?: Parameters<typeof morgan>[1]): /*elided*/ any;
+        withSwagger(swagger: {
+            path?: ExpressRoute;
             doc: SwaggerConfig;
+        }, ...handlers: ExpressHandler[]): /*elided*/ any;
+        defaults: {
+            get(swagger: {
+                path?: ExpressRoute;
+                doc: SwaggerConfig;
+            }): express.Express;
         };
-        options?: {
-            helmet?: Readonly<helmet.HelmetOptions>;
-            morgan?: Readonly<{
-                format: string;
-                options?: Parameters<typeof morgan>[1];
-            }>;
-        };
-        app?: express.Express;
-    }): express.Express;
+    };
     expressiveRouter(configs: {
         oapi?: {
             tags?: string[];

package/dist/index.d.ts

@@ -34,9 +34,61 @@ type Container = {
     alertHandler?: AlertHandler;
 };
 
-type Schema = Record<string, unknown> | {
+type NumericConfigs = {
+    minimum?: number;
+    maximum?: number;
+    exclusiveMinimum?: boolean;
+    exclusiveMaximum?: boolean;
+    multipleOf?: number;
+};
+type NumberType = {
+    type: 'number';
+    format?: 'float' | 'double';
+} & NumericConfigs;
+type IntegerType = {
+    type: 'integer';
+    format?: 'int32' | 'int64';
+} & NumericConfigs;
+type StringType = {
+    type: 'string';
+    minLength?: number;
+    maxLength?: number;
+    format?: 'date' | 'date-time' | 'password' | 'byte' | 'binary' | 'email' | 'uuid' | 'uri' | 'hostname' | 'ipv4' | 'ipv6';
+    pattern?: string;
+};
+type BooleanType = {
+    type: 'boolean';
+};
+type ArrayType = {
+    type: 'array';
+    items: Partial<Schema>;
+    minItems?: number;
+    maxItems?: number;
+    uniqueItems?: boolean;
+};
+type ObjectType = {
+    type: 'object';
+    properties?: Record<string, Schema>;
+    required?: string[];
+    additionalProperties?: boolean | Schema;
+    minProperties?: number;
+    maxProperties?: number;
+};
+type BaseSchema = ({
+    nullable?: boolean;
+    enum?: unknown[];
+    description?: string;
+    default?: unknown;
+} & (StringType | NumberType | IntegerType | BooleanType | ArrayType | ObjectType)) | {
     $ref: string;
 };
+type Schema = BaseSchema | {
+    allOf: BaseSchema[];
+} | {
+    anyOf: BaseSchema[];
+} | {
+    oneOf: BaseSchema[];
+};
 type Content = {
     description?: string;
     content?: Partial<Record<ContentType, {
@@ -46,7 +98,7 @@ type Content = {
 type Param = {
     in: 'path' | 'query' | 'headers';
     name: string;
-    desciption: string;
+    description: string;
     required: boolean;
     schema: Schema;
 };
@@ -225,19 +277,23 @@ declare function bootstrap(container: Container): {
         get(): SwaggerConfig;
     };
     expressiveServer(configs: {
-        swagger: {
-            path: ExpressRoute;
+        app?: express.Express;
+    }): {
+        get(): express.Express;
+        withHelmet(options?: Readonly<helmet.HelmetOptions>): /*elided*/ any;
+        withQs(): /*elided*/ any;
+        withMorgan(format?: string, options?: Parameters<typeof morgan>[1]): /*elided*/ any;
+        withSwagger(swagger: {
+            path?: ExpressRoute;
             doc: SwaggerConfig;
+        }, ...handlers: ExpressHandler[]): /*elided*/ any;
+        defaults: {
+            get(swagger: {
+                path?: ExpressRoute;
+                doc: SwaggerConfig;
+            }): express.Express;
         };
-        options?: {
-            helmet?: Readonly<helmet.HelmetOptions>;
-            morgan?: Readonly<{
-                format: string;
-                options?: Parameters<typeof morgan>[1];
-            }>;
-        };
-        app?: express.Express;
-    }): express.Express;
+    };
     expressiveRouter(configs: {
         oapi?: {
             tags?: string[];

package/dist/index.js

@@ -154,7 +154,7 @@ function param(inP, id, schema, required = true, description = "", name) {
   return {
     in: inP,
     name: name ?? id,
-    desciption: description,
+    description,
     required,
     schema
   };
@@ -193,24 +193,45 @@ var SWG = {
 function buildExpressive(container, swaggerDoc) {
   return {
     expressiveServer(configs) {
-      const { options } = configs;
       const app = configs.app ?? (0, import_express.default)();
-      app.use((0, import_helmet.default)(options?.helmet ?? {}));
-      app.set("query parser", function(str) {
-        return import_qs.default.parse(str, { decoder(s) {
-          return decodeURIComponent(s);
-        } });
-      });
-      app.use((0, import_morgan.default)(
-        options?.morgan?.format ?? ":req[x-real-ip] :method :url :status :res[content-length] - :response-time ms",
-        options?.morgan?.options ?? { stream: { write(message) {
-          container.logger.info(message.trim());
-        } } }
-      ));
-      app.use(configs.swagger.path, import_swagger_ui_express.default.serve, import_swagger_ui_express.default.setup(configs.swagger.doc, {
-        customSiteTitle: configs.swagger.doc.info?.title
-      }));
-      return app;
+      const result = {
+        get() {
+          return app;
+        },
+        withHelmet(options) {
+          app.use((0, import_helmet.default)(options ?? {}));
+          return this;
+        },
+        withQs() {
+          app.set("query parser", function(str) {
+            return import_qs.default.parse(str, { decoder(s) {
+              return decodeURIComponent(s);
+            } });
+          });
+          return this;
+        },
+        withMorgan(format, options) {
+          app.use((0, import_morgan.default)(
+            format ?? ":req[x-real-ip] :method :url :status :res[content-length] - :response-time ms",
+            options ?? { stream: { write(message) {
+              container.logger.info(message.trim());
+            } } }
+          ));
+          return this;
+        },
+        withSwagger(swagger, ...handlers) {
+          app.use(swagger.path ?? "/api-docs", ...handlers, import_swagger_ui_express.default.serve, import_swagger_ui_express.default.setup(swagger.doc, {
+            customSiteTitle: swagger.doc.info?.title
+          }));
+          return this;
+        },
+        defaults: {
+          get(swagger) {
+            return result.withHelmet().withQs().withMorgan().withSwagger(swagger).get();
+          }
+        }
+      };
+      return result;
     },
     expressiveRouter(configs) {
       const router = import_express.default.Router();

package/dist/index.mjs

@@ -89,7 +89,7 @@ function param(inP, id, schema, required = true, description = "", name) {
   return {
     in: inP,
     name: name ?? id,
-    desciption: description,
+    description,
     required,
     schema
   };
@@ -128,24 +128,45 @@ var SWG = {
 function buildExpressive(container, swaggerDoc) {
   return {
     expressiveServer(configs) {
-      const { options } = configs;
       const app = configs.app ?? express();
-      app.use(helmet(options?.helmet ?? {}));
-      app.set("query parser", function(str) {
-        return qs.parse(str, { decoder(s) {
-          return decodeURIComponent(s);
-        } });
-      });
-      app.use(morgan(
-        options?.morgan?.format ?? ":req[x-real-ip] :method :url :status :res[content-length] - :response-time ms",
-        options?.morgan?.options ?? { stream: { write(message) {
-          container.logger.info(message.trim());
-        } } }
-      ));
-      app.use(configs.swagger.path, swaggerUi.serve, swaggerUi.setup(configs.swagger.doc, {
-        customSiteTitle: configs.swagger.doc.info?.title
-      }));
-      return app;
+      const result = {
+        get() {
+          return app;
+        },
+        withHelmet(options) {
+          app.use(helmet(options ?? {}));
+          return this;
+        },
+        withQs() {
+          app.set("query parser", function(str) {
+            return qs.parse(str, { decoder(s) {
+              return decodeURIComponent(s);
+            } });
+          });
+          return this;
+        },
+        withMorgan(format, options) {
+          app.use(morgan(
+            format ?? ":req[x-real-ip] :method :url :status :res[content-length] - :response-time ms",
+            options ?? { stream: { write(message) {
+              container.logger.info(message.trim());
+            } } }
+          ));
+          return this;
+        },
+        withSwagger(swagger, ...handlers) {
+          app.use(swagger.path ?? "/api-docs", ...handlers, swaggerUi.serve, swaggerUi.setup(swagger.doc, {
+            customSiteTitle: swagger.doc.info?.title
+          }));
+          return this;
+        },
+        defaults: {
+          get(swagger) {
+            return result.withHelmet().withQs().withMorgan().withSwagger(swagger).get();
+          }
+        }
+      };
+      return result;
     },
     expressiveRouter(configs) {
       const router = express.Router();

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@extk/expressive",
-    "version": "0.2.1",
+    "version": "0.3.0",
     "type": "commonjs",
     "publishConfig": {
         "access": "public"
@@ -25,7 +25,7 @@
         "lint": "eslint ./"
     },
     "devDependencies": {
-        "@extk/eslint-config": "^0.2.0",
+        "@extk/eslint-config": "^0.2.1",
         "@extk/tsconfig": "0.1.1",
         "@types/chance": "^1.1.7",
         "@types/express": "^5.0.1",