@nimee/initialize-ms 1.0.2 → 1.0.4

package/dist/src/fastify.d.ts

@@ -5,7 +5,10 @@ declare module "@fastify/request-context" {
 }
 declare class ServerInitializerFastify {
     server: any;
-    initialize(serviceName?: string): Promise<any>;
+    initialize(params: {
+        serviceName: string;
+        port: number;
+    }): Promise<any>;
     listen(port?: number): Promise<any>;
 }
 export default ServerInitializerFastify;

package/dist/src/fastify.js

@@ -16,11 +16,14 @@ const fastify_1 = __importDefault(require("fastify"));
 const logger_1 = __importDefault(require("@nimee/logger"));
 const request_context_1 = __importDefault(require("@fastify/request-context"));
 const crypto_1 = __importDefault(require("crypto"));
+const swagger_1 = __importDefault(require("@fastify/swagger"));
+const swagger_ui_1 = __importDefault(require("@fastify/swagger-ui"));
 const uuid = crypto_1.default.randomUUID();
 class ServerInitializerFastify {
-    initialize(serviceName) {
+    initialize(params) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
+                const { serviceName, port } = params;
                 this.server = (0, fastify_1.default)({
                     logger: logger_1.default,
                     requestIdLogLabel: "reqId",
@@ -36,10 +39,27 @@ class ServerInitializerFastify {
                 this.server.register(request_context_1.default, {
                     hook: "preValidation",
                 });
-                // this.server.addHook("preHandler", async (request: any) => {
-                //   requestContext.set("user", request.user);
-                //   logger.info(`1user:${requestContext.get("user")}`);
-                // });
+                yield this.server.register(swagger_1.default, {
+                    swagger: {
+                        info: {
+                            title: `${serviceName.toLocaleUpperCase()} Service`,
+                            description: "Testing the NIMI API",
+                            version: "0.1.0",
+                        },
+                        host: `localhost:${port}`,
+                        schemes: ["http"],
+                        consumes: ["application/json"],
+                        produces: ["application/json"],
+                    },
+                });
+                yield this.server.register(swagger_ui_1.default, {
+                    routePrefix: `/${serviceName}/documentation`,
+                    initOAuth: {},
+                    uiConfig: {
+                        docExpansion: "full",
+                        deepLinking: false,
+                    },
+                });
                 return this.server;
             }
             catch (err) {

package/dist/src/fastify.js.map

@@ -1 +1 @@
-{"version":3,"file":"fastify.js","sourceRoot":"","sources":["../../src/fastify.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,sDAAkD;AAClD,2DAAmC;AACnC,+EAAmE;AACnE,oDAA4B;AAC5B,MAAM,IAAI,GAAG,gBAAM,CAAC,UAAU,EAAE,CAAC;AAQjC,MAAM,wBAAwB;IAEtB,UAAU,CAAC,WAAoB;;YACnC,IAAI;gBACF,IAAI,CAAC,MAAM,GAAG,IAAA,iBAAO,EAAC;oBACpB,MAAM,EAAN,gBAAM;oBACN,iBAAiB,EAAE,OAAO;oBAC1B,QAAQ,CAAC,GAAmB;wBAC1B,iFAAiF;wBACjF,OAAO,IAAI,CAAC;oBACd,CAAC;iBACF,CAAC,CAAC;gBAEH,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE;oBAC7C,MAAM,EAAE,CAAC,uBAAuB,EAAE,uBAAuB,EAAE,uBAAuB,CAAC;oBACnF,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC;iBACnD,CAAC,CAAC;gBACH,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,yBAA2B,EAAE;oBAChD,IAAI,EAAE,eAAe;iBACtB,CAAC,CAAC;gBACH,8DAA8D;gBAC9D,8CAA8C;gBAC9C,wDAAwD;gBACxD,MAAM;gBAEN,OAAO,IAAI,CAAC,MAAM,CAAC;aACpB;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC3B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACjB;QACH,CAAC;KAAA;IACK,MAAM,CAAC,IAAa;;YACxB,IAAI;gBACF,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;gBACpD,OAAO,IAAI,CAAC,MAAM,CAAC;aACpB;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC3B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACjB;QACH,CAAC;KAAA;CACF;AAED,kBAAe,wBAAwB,CAAC"}
+{"version":3,"file":"fastify.js","sourceRoot":"","sources":["../../src/fastify.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,sDAAkD;AAClD,2DAAmC;AACnC,+EAAmE;AACnE,oDAA4B;AAC5B,+DAA8C;AAC9C,qEAAmD;AAEnD,MAAM,IAAI,GAAG,gBAAM,CAAC,UAAU,EAAE,CAAC;AAQjC,MAAM,wBAAwB;IAEtB,UAAU,CAAC,MAA6C;;YAC5D,IAAI;gBACF,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;gBACrC,IAAI,CAAC,MAAM,GAAG,IAAA,iBAAO,EAAC;oBACpB,MAAM,EAAN,gBAAM;oBACN,iBAAiB,EAAE,OAAO;oBAC1B,QAAQ,CAAC,GAAmB;wBAC1B,iFAAiF;wBACjF,OAAO,IAAI,CAAC;oBACd,CAAC;iBACF,CAAC,CAAC;gBACH,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE;oBAC7C,MAAM,EAAE,CAAC,uBAAuB,EAAE,uBAAuB,EAAE,uBAAuB,CAAC;oBACnF,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC;iBACnD,CAAC,CAAC;gBACH,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,yBAA2B,EAAE;oBAChD,IAAI,EAAE,eAAe;iBACtB,CAAC,CAAC;gBAEH,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAc,EAAE;oBACzC,OAAO,EAAE;wBACP,IAAI,EAAE;4BACJ,KAAK,EAAE,GAAG,WAAW,CAAC,iBAAiB,EAAE,UAAU;4BACnD,WAAW,EAAE,sBAAsB;4BACnC,OAAO,EAAE,OAAO;yBACjB;wBACD,IAAI,EAAE,aAAa,IAAI,EAAE;wBACzB,OAAO,EAAE,CAAC,MAAM,CAAC;wBACjB,QAAQ,EAAE,CAAC,kBAAkB,CAAC;wBAC9B,QAAQ,EAAE,CAAC,kBAAkB,CAAC;qBAC/B;iBACF,CAAC,CAAC;gBAEH,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,oBAAgB,EAAE;oBAC3C,WAAW,EAAE,IAAI,WAAW,gBAAgB;oBAC5C,SAAS,EAAE,EAAE;oBACb,QAAQ,EAAE;wBACR,YAAY,EAAE,MAAM;wBACpB,WAAW,EAAE,KAAK;qBACnB;iBACF,CAAC,CAAC;gBAEH,OAAO,IAAI,CAAC,MAAM,CAAC;aACpB;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC3B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACjB;QACH,CAAC;KAAA;IACK,MAAM,CAAC,IAAa;;YACxB,IAAI;gBACF,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;gBACpD,OAAO,IAAI,CAAC,MAAM,CAAC;aACpB;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC3B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACjB;QACH,CAAC;KAAA;CACF;AAED,kBAAe,wBAAwB,CAAC"}

package/dist/src/index.js

@@ -26,7 +26,7 @@ class AppInitializer {
                 case "fastify": {
                     logger_1.default.info("Initializing Fastify now!");
                     fastify = new fastify_1.default();
-                    this.server = yield fastify.initialize(serviceName);
+                    this.server = yield fastify.initialize({ serviceName, port });
                     break;
                 }
                 case "express": {

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,wDAAiD;AACjD,2DAAmC;AACnC,wDAAoD;AACpD,2DAA0C;AAC1C,4CAAwD;AACxD,MAAM,cAAc;IAKZ,UAAU,CACd,MAAW,EACX,UAAkB,EAClB,WAAmB,EACnB,sBAA2B,EAC3B,gBAAwB,EACxB,YAAiB,EACjB,gBAA+B,EAC/B,IAAY;;YAEZ,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;YAC/B,IAAI,OAAO,CAAC;YACZ,QAAQ,UAAU,EAAE;gBAClB,KAAK,SAAS,CAAC,CAAC;oBACd,gBAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;oBACzC,OAAO,GAAG,IAAI,iBAAwB,EAAE,CAAC;oBACzC,IAAI,CAAC,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;oBACpD,MAAM;iBACP;gBACD,KAAK,SAAS,CAAC,CAAC;oBACd,8EAA8E;oBAC9E,MAAM;iBACP;aACF;YACD,IAAI,YAAY,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAAE,MAAM,YAAY,CAAC,WAAW,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;YACvH,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;gBACvC,oFAAoF;aACrF;YACD,4BAAY,CAAC,0BAA0B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACrD,MAAM,IAAI,gBAAa,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACxE,gCAAsB,CAAC,8BAA8B,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAE3G,IAAI,sBAAsB,EAAE;gBAC1B,MAAM,yBAAyB,GAAG,CAAC,sBAAsB,CAAC,CAAC;gBAC3D,yBAAyB,CAAC,OAAO,CAAC,CAAC,qBAAqB,EAAE,EAAE;oBAC1D,gBAAM,CAAC,IAAI,CAAC,mDAAmD,IAAI,CAAC,WAAW,KAAK,CAAC,CAAC;oBACtF,IAAI,qBAAqB,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACtD,CAAC,CAAC,CAAC;gBACH,gBAAM,CAAC,IAAI,CAAC,sCAAsC,IAAI,CAAC,WAAW,KAAK,CAAC,CAAC;aAC1E;YACD,IAAI,UAAU;gBAAE,MAAM,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;KAAA;CACF;AAED,kBAAe,cAAc,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,wDAAiD;AACjD,2DAAmC;AACnC,wDAAoD;AACpD,2DAA0C;AAC1C,4CAAwD;AACxD,MAAM,cAAc;IAKZ,UAAU,CACd,MAAW,EACX,UAAkB,EAClB,WAAmB,EACnB,sBAA2B,EAC3B,gBAAwB,EACxB,YAAiB,EACjB,gBAA+B,EAC/B,IAAY;;YAEZ,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;YAC/B,IAAI,OAAO,CAAC;YACZ,QAAQ,UAAU,EAAE;gBAClB,KAAK,SAAS,CAAC,CAAC;oBACd,gBAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;oBACzC,OAAO,GAAG,IAAI,iBAAwB,EAAE,CAAC;oBACzC,IAAI,CAAC,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;oBAC9D,MAAM;iBACP;gBACD,KAAK,SAAS,CAAC,CAAC;oBACd,8EAA8E;oBAC9E,MAAM;iBACP;aACF;YACD,IAAI,YAAY,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAAE,MAAM,YAAY,CAAC,WAAW,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;YACvH,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;gBACvC,oFAAoF;aACrF;YACD,4BAAY,CAAC,0BAA0B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACrD,MAAM,IAAI,gBAAa,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACxE,gCAAsB,CAAC,8BAA8B,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAE3G,IAAI,sBAAsB,EAAE;gBAC1B,MAAM,yBAAyB,GAAG,CAAC,sBAAsB,CAAC,CAAC;gBAC3D,yBAAyB,CAAC,OAAO,CAAC,CAAC,qBAAqB,EAAE,EAAE;oBAC1D,gBAAM,CAAC,IAAI,CAAC,mDAAmD,IAAI,CAAC,WAAW,KAAK,CAAC,CAAC;oBACtF,IAAI,qBAAqB,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACtD,CAAC,CAAC,CAAC;gBACH,gBAAM,CAAC,IAAI,CAAC,sCAAsC,IAAI,CAAC,WAAW,KAAK,CAAC,CAAC;aAC1E;YACD,IAAI,UAAU;gBAAE,MAAM,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;KAAA;CACF;AAED,kBAAe,cAAc,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nimee/initialize-ms",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "init behavior for each ms",
   "main": "dist/src/index.js",
   "author": "dan goldberg",
@@ -29,6 +29,7 @@
     "@fastify/cors": "^8.1.1",
     "@fastify/request-context": "^4.2.0",
     "@fastify/swagger": "^8.1.0",
+    "@fastify/swagger-ui": "^1.3.0",
     "@nimee/error-handler": "0.0.4",
     "@nimee/health": "2.1.1",
     "@nimee/logger": "1.0.21",

package/src/fastify.ts

@@ -2,6 +2,9 @@ import Fastify, { FastifyRequest } from "fastify";
 import logger from "@nimee/logger";
 import fastifyRequestContextPlugin from "@fastify/request-context";
 import crypto from "crypto";
+import fastifySwagger from "@fastify/swagger";
+import fastifySwaggerUi from "@fastify/swagger-ui";
+
 const uuid = crypto.randomUUID();
 
 declare module "@fastify/request-context" {
@@ -12,8 +15,9 @@ declare module "@fastify/request-context" {
 
 class ServerInitializerFastify {
   server: any;
-  async initialize(serviceName?: string) {
+  async initialize(params: { serviceName: string; port: number }) {
     try {
+      const { serviceName, port } = params;
       this.server = Fastify({
         logger,
         requestIdLogLabel: "reqId",
@@ -22,7 +26,6 @@ class ServerInitializerFastify {
           return uuid;
         },
       });
-
       this.server.register(require("@fastify/cors"), {
         origin: ["http://localhost:8080", "http://127.0.0.1:8080", "http://localhost:3000"],
         methods: ["GET", "PUT", "PATCH", "POST", "DELETE"],
@@ -30,10 +33,29 @@ class ServerInitializerFastify {
       this.server.register(fastifyRequestContextPlugin, {
         hook: "preValidation",
       });
-      // this.server.addHook("preHandler", async (request: any) => {
-      //   requestContext.set("user", request.user);
-      //   logger.info(`1user:${requestContext.get("user")}`);
-      // });
+
+      await this.server.register(fastifySwagger, {
+        swagger: {
+          info: {
+            title: `${serviceName.toLocaleUpperCase()} Service`,
+            description: "Testing the NIMI API",
+            version: "0.1.0",
+          },
+          host: `localhost:${port}`,
+          schemes: ["http"],
+          consumes: ["application/json"],
+          produces: ["application/json"],
+        },
+      });
+
+      await this.server.register(fastifySwaggerUi, {
+        routePrefix: `/${serviceName}/documentation`,
+        initOAuth: {},
+        uiConfig: {
+          docExpansion: "full",
+          deepLinking: false,
+        },
+      });
 
       return this.server;
     } catch (err) {

package/src/index.ts

@@ -24,7 +24,7 @@ class AppInitializer {
       case "fastify": {
         logger.info("Initializing Fastify now!");
         fastify = new ServerInitializerFastify();
-        this.server = await fastify.initialize(serviceName);
+        this.server = await fastify.initialize({ serviceName, port });
         break;
       }
       case "express": {