node-server-engine 1.1.1 → 1.1.3

package/src/middleware/fileUploader/fileUploader.types.ts

@@ -1,52 +1,52 @@
-import { CompressionOptions } from './compressAvatar';
-import { StorageUploadedFile } from 'entities/Storage';
-
-// Override the Express request object to add the files
-declare global {
-  // eslint-disable-next-line @typescript-eslint/no-namespace
-  namespace Express {
-    /** Express request object */
-    interface Request {
-      /** Configuration for files that are uploaded with the request */
-      files?: { [key: string]: Array<UploadedFile> };
-    }
-  }
-}
-
-/** Custom uploaded file metadata */
-export interface UploadedFile extends StorageUploadedFile {
-  /** File name that was given to the file by the client */
-  originalFileName: string;
-}
-
-/** Outputs setting for the file upload. Defines where a file should be stored and how it should be processed. */
-interface FileUploaderOutputs {
-  /** Name of the output */
-  name: string;
-  /** Path to which this specific output is stored (defaults to default path if not set) */
-  path?: string;
-  /** Bucket to which this specific output is stored (defaults to default bucket if not set) */
-  bucket?: string;
-}
-
-/** Configuration for a file upload */
-export interface FileUploaderConfig {
-  /** Field key for which this configuration applies */
-  key: string;
-  /** A list of supported MIME Types for the file */
-  mimeTypes?: Array<string>;
-  /** Base path where the file should be stored (default used when no output config is set, will be used as temporary storage when outputs are set) */
-  path?: string;
-  /** Bucket in which the file should be stored (will be used as temporary storage when outputs are set) */
-  bucket: string;
-  /** Maximum size of the file (ex: 2MB) */
-  maxSize?: string;
-  /** Indicates that the file must be present */
-  required?: boolean;
-  /** Do not store with an extension (will simply be a uuid) */
-  noExtension?: boolean;
-  /** Specify multiple outputs with processing */
-  outputs?: Array<FileUploaderOutputs>;
-  /** @deprecated compression of images */
-  image?: CompressionOptions;
-}
+import { CompressionOptions } from './compressAvatar';
+import { StorageUploadedFile } from 'entities/Storage';
+
+// Override the Express request object to add the files
+declare global {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
+  namespace Express {
+    /** Express request object */
+    interface Request {
+      /** Configuration for files that are uploaded with the request */
+      files?: { [key: string]: Array<UploadedFile> };
+    }
+  }
+}
+
+/** Custom uploaded file metadata */
+export interface UploadedFile extends StorageUploadedFile {
+  /** File name that was given to the file by the client */
+  originalFileName: string;
+}
+
+/** Outputs setting for the file upload. Defines where a file should be stored and how it should be processed. */
+interface FileUploaderOutputs {
+  /** Name of the output */
+  name: string;
+  /** Path to which this specific output is stored (defaults to default path if not set) */
+  path?: string;
+  /** Bucket to which this specific output is stored (defaults to default bucket if not set) */
+  bucket?: string;
+}
+
+/** Configuration for a file upload */
+export interface FileUploaderConfig {
+  /** Field key for which this configuration applies */
+  key: string;
+  /** A list of supported MIME Types for the file */
+  mimeTypes?: Array<string>;
+  /** Base path where the file should be stored (default used when no output config is set, will be used as temporary storage when outputs are set) */
+  path?: string;
+  /** Bucket in which the file should be stored (will be used as temporary storage when outputs are set) */
+  bucket: string;
+  /** Maximum size of the file (ex: 2MB) */
+  maxSize?: string;
+  /** Indicates that the file must be present */
+  required?: boolean;
+  /** Do not store with an extension (will simply be a uuid) */
+  noExtension?: boolean;
+  /** Specify multiple outputs with processing */
+  outputs?: Array<FileUploaderOutputs>;
+  /** @deprecated compression of images */
+  image?: CompressionOptions;
+}

package/src/middleware/fileUploader/index.ts

@@ -1,2 +1,2 @@
-export * from './fileUploader';
-export * from './fileUploader.types';
+export * from './fileUploader';
+export * from './fileUploader.types';

package/src/middleware/fileUploader/isMultiPart/index.ts

@@ -1 +1 @@
-export * from './isMultipart';
+export * from './isMultipart';

package/src/middleware/fileUploader/isMultiPart/isMultipart.ts

@@ -1,9 +1,9 @@
-import { Request } from 'express';
-
-const multipartRegex = /^multipart\/form-data.+$/;
-
-/** Determines if the content type of a request is multipart/form-data */
-export function isMultipart(request: Request): boolean {
-  const type = request.get('Content-Type');
-  return !!type && multipartRegex.test(type.toLowerCase());
-}
+import { Request } from 'express';
+
+const multipartRegex = /^multipart\/form-data.+$/;
+
+/** Determines if the content type of a request is multipart/form-data */
+export function isMultipart(request: Request): boolean {
+  const type = request.get('Content-Type');
+  return !!type && multipartRegex.test(type.toLowerCase());
+}

package/src/middleware/fileUploader/validate/index.ts

@@ -1 +1 @@
-export * from './validate';
+export * from './validate';

package/src/middleware/fileUploader/validate/validate.ts

@@ -1,27 +1,27 @@
-import { Request } from 'express';
-import { Schema } from 'express-validator';
-import { validate as validateMiddleware } from 'middleware/validate';
-
-/** Validate a schema against a request using our validation middleware */
-export async function validate(
-  request: Request,
-  schema: Schema
-): Promise<void> {
-  return new Promise((resolve, reject) => {
-    // Generate a validation chain using our middleware
-    const validationChain = validateMiddleware(schema).flat();
-    if (!validationChain.length) resolve();
-    // Recursively go through each middleware by imitating the next function from express
-    let position = -1;
-    const next = (error?: unknown): void => {
-      if (error) reject(error);
-      position++;
-      if (position === validationChain.length) {
-        resolve();
-        return;
-      }
-      validationChain[position](request, undefined, next);
-    };
-    next();
-  });
-}
+import { Request } from 'express';
+import { Schema } from 'express-validator';
+import { validate as validateMiddleware } from 'middleware/validate';
+
+/** Validate a schema against a request using our validation middleware */
+export async function validate(
+  request: Request,
+  schema: Schema
+): Promise<void> {
+  return new Promise((resolve, reject) => {
+    // Generate a validation chain using our middleware
+    const validationChain = validateMiddleware(schema).flat();
+    if (!validationChain.length) resolve();
+    // Recursively go through each middleware by imitating the next function from express
+    let position = -1;
+    const next = (error?: unknown): void => {
+      if (error) reject(error);
+      position++;
+      if (position === validationChain.length) {
+        resolve();
+        return;
+      }
+      validationChain[position](request, undefined, next);
+    };
+    next();
+  });
+}

package/src/middleware/fourOhFour/fourOhFour.test.ts

@@ -1,14 +1,14 @@
-import express from 'express';
-import supertest from 'supertest';
-import { fourOhFour } from './fourOhFour';
-
-describe('Middleware - fourOhFour', () => {
-  it('should 404 everything', async () => {
-    const app = express();
-    app.get('/example', (req: any, res: any) => res.sendStatus(200));
-    app.use(fourOhFour);
-
-    await supertest(app).get('/example').expect(200);
-    await supertest(app).get('/nope').expect(404);
-  });
-});
+import express from 'express';
+import supertest from 'supertest';
+import { fourOhFour } from './fourOhFour';
+
+describe('Middleware - fourOhFour', () => {
+  it('should 404 everything', async () => {
+    const app = express();
+    app.get('/example', (req: any, res: any) => res.sendStatus(200));
+    app.use(fourOhFour);
+
+    await supertest(app).get('/example').expect(200);
+    await supertest(app).get('/nope').expect(404);
+  });
+});

package/src/middleware/fourOhFour/fourOhFour.ts

@@ -1,13 +1,13 @@
-import { Request, Response } from 'express';
-import { reportDebug } from 'utils';
-
-const namespace = 'engine:middleware:fourOhFour';
-
-/** Unhandled path middleware */
-export function fourOhFour(request: Request, response: Response): void {
-  reportDebug({
-    namespace,
-    message: `No route found [${request.method} - ${request.path}]`
-  });
-  response.sendStatus(404);
-}
+import { Request, Response } from 'express';
+import { reportDebug } from 'utils';
+
+const namespace = 'engine:middleware:fourOhFour';
+
+/** Unhandled path middleware */
+export function fourOhFour(request: Request, response: Response): void {
+  reportDebug({
+    namespace,
+    message: `No route found [${request.method} - ${request.path}]`
+  });
+  response.sendStatus(404);
+}

package/src/middleware/fourOhFour/index.ts

@@ -1 +1 @@
-export * from './fourOhFour';
+export * from './fourOhFour';

package/src/middleware/geminiFileUploader/geminiFileUploader.ts

@@ -1,117 +1,117 @@
-import express from 'express';
-import multer from 'multer';
-import { GoogleAIFileManager } from '@google/generative-ai/server';
-import fs from 'fs';
-import path from 'path';
-import tmp from 'tmp';
-import { reportError, reportDebug } from 'utils/report';
-import { checkEnvironment } from 'utils/checkEnvironment';
-import { envAssert } from 'utils/envAssert';
-
-const namespace = 'engine:middleware:geminiFileUploader';
-
-const apiKey = process.env.GOOGLE_AI_KEY ?? '';
-const fileManager = new GoogleAIFileManager(apiKey);
-
-const storage = multer.memoryStorage();
-
-async function uploadToGemini(
-  buffer: Buffer,
-  mimeType: string,
-  originalName: string
-): Promise<{ name: string; uri: string; mimeType: string }> {
-  // Add 'name' to the return type
-  const tempFile = tmp.fileSync({ postfix: path.extname(originalName) });
-
-  fs.writeFileSync(tempFile.name, buffer);
-
-  const uploadResult = await fileManager.uploadFile(tempFile.name, {
-    mimeType,
-    displayName: originalName
-  });
-
-  tempFile.removeCallback();
-
-  const file = uploadResult.file;
-  reportDebug({
-    namespace,
-    message: 'Uploaded file',
-    data: { displayName: file.displayName, name: file.name }
-  });
-  return { name: file.name, uri: file.uri, mimeType: file.mimeType }; // Include 'name' in the return object
-}
-
-async function waitForFilesActive(
-  files: { name: string; uri: string; mimeType: string }[]
-): Promise<void> {
-  reportDebug({
-    namespace,
-    message: 'Waiting for file processing...'
-  });
-  for (const { name } of files) {
-    let file = await fileManager.getFile(name);
-    while (file.state === 'PROCESSING') {
-      process.stdout.write('.');
-      await new Promise((resolve) => setTimeout(resolve, 10_000));
-      file = await fileManager.getFile(name);
-    }
-    if (file.state !== 'ACTIVE') {
-      reportError(`File ${file.name} failed to process`);
-    }
-  }
-  reportDebug({
-    namespace,
-    message: 'all files ready...\n'
-  });
-}
-
-export async function geminiFileUploader(
-  req: express.Request,
-  res: express.Response,
-  next: express.NextFunction
-): Promise<void> {
-  try {
-    checkEnvironment({
-      GOOGLE_AI_KEY: envAssert.isString()
-    });
-    // Use multer.single() inside the middleware
-    const uploadSingle = multer({ storage }).single('file');
-
-    uploadSingle(req, res, async (err) => {
-      if (err) {
-        reportError(`Error uploading file`);
-        next(err);
-        return;
-      }
-
-      const file = req.file;
-      if (!file) {
-        reportError(`No file uploaded`);
-        next(`No file uploaded`);
-        return;
-      }
-      const mimeType = file.mimetype;
-
-      const uploadedFile = await uploadToGemini(
-        file.buffer,
-        mimeType,
-        file.originalname
-      );
-
-      await waitForFilesActive([uploadedFile]);
-
-      // Set the fileUri and mimeType in the request object for the next middleware/route handler
-      req.body.file = {
-        fileUri: uploadedFile.uri,
-        mimeType: uploadedFile.mimeType,
-        originalname: file.originalname
-      };
-
-      next(); // Proceed to the next middleware or route handler
-    });
-  } catch (error) {
-    console.error(error);
-    reportError(`Failed to upload or process file`);
-    next(error);
-  }
-}
+import express from 'express';
+import multer from 'multer';
+import { GoogleAIFileManager } from '@google/generative-ai/server';
+import fs from 'fs';
+import path from 'path';
+import tmp from 'tmp';
+import { reportError, reportDebug } from 'utils/report';
+import { checkEnvironment } from 'utils/checkEnvironment';
+import { envAssert } from 'utils/envAssert';
+
+const namespace = 'engine:middleware:geminiFileUploader';
+
+const apiKey = process.env.GOOGLE_AI_KEY ?? '';
+const fileManager = new GoogleAIFileManager(apiKey);
+
+const storage = multer.memoryStorage();
+
+async function uploadToGemini(
+  buffer: Buffer,
+  mimeType: string,
+  originalName: string
+): Promise<{ name: string; uri: string; mimeType: string }> {
+  // Add 'name' to the return type
+  const tempFile = tmp.fileSync({ postfix: path.extname(originalName) });
+
+  fs.writeFileSync(tempFile.name, buffer);
+
+  const uploadResult = await fileManager.uploadFile(tempFile.name, {
+    mimeType,
+    displayName: originalName
+  });
+
+  tempFile.removeCallback();
+
+  const file = uploadResult.file;
+  reportDebug({
+    namespace,
+    message: 'Uploaded file',
+    data: { displayName: file.displayName, name: file.name }
+  });
+  return { name: file.name, uri: file.uri, mimeType: file.mimeType }; // Include 'name' in the return object
+}
+
+async function waitForFilesActive(
+  files: { name: string; uri: string; mimeType: string }[]
+): Promise<void> {
+  reportDebug({
+    namespace,
+    message: 'Waiting for file processing...'
+  });
+  for (const { name } of files) {
+    let file = await fileManager.getFile(name);
+    while (file.state === 'PROCESSING') {
+      process.stdout.write('.');
+      await new Promise((resolve) => setTimeout(resolve, 10_000));
+      file = await fileManager.getFile(name);
+    }
+    if (file.state !== 'ACTIVE') {
+      reportError(`File ${file.name} failed to process`);
+    }
+  }
+  reportDebug({
+    namespace,
+    message: 'all files ready...\n'
+  });
+}
+
+export async function geminiFileUploader(
+  req: express.Request,
+  res: express.Response,
+  next: express.NextFunction
+): Promise<void> {
+  try {
+    checkEnvironment({
+      GOOGLE_AI_KEY: envAssert.isString()
+    });
+    // Use multer.single() inside the middleware
+    const uploadSingle = multer({ storage }).single('file');
+
+    uploadSingle(req, res, async (err) => {
+      if (err) {
+        reportError(`Error uploading file`);
+        next(err);
+        return;
+      }
+
+      const file = req.file;
+      if (!file) {
+        reportError(`No file uploaded`);
+        next(`No file uploaded`);
+        return;
+      }
+      const mimeType = file.mimetype;
+
+      const uploadedFile = await uploadToGemini(
+        file.buffer,
+        mimeType,
+        file.originalname
+      );
+
+      await waitForFilesActive([uploadedFile]);
+
+      // Set the fileUri and mimeType in the request object for the next middleware/route handler
+      req.body.file = {
+        fileUri: uploadedFile.uri,
+        mimeType: uploadedFile.mimeType,
+        originalname: file.originalname
+      };
+
+      next(); // Proceed to the next middleware or route handler
+    });
+  } catch (error) {
+    console.error(error);
+    reportError(`Failed to upload or process file`);
+    next(error);
+  }
+}

package/src/middleware/geminiFileUploader/index.ts

@@ -1 +1 @@
-export * from './geminiFileUploader';
+export * from './geminiFileUploader';

package/src/middleware/healthCheck/healthCheck.test.ts

@@ -1,12 +1,12 @@
-import express from 'express';
-import request from 'supertest';
-import { healthCheck } from './healthCheck';
-
-describe('Middleware - healthCheck', () => {
-  it('default healtcheck route', async () => {
-    const app = express();
-    app.use(healthCheck());
-    await request(app).get('/').expect(200);
-    await request(app).get('/heartbeat').expect(200);
-  });
-});
+import express from 'express';
+import request from 'supertest';
+import { healthCheck } from './healthCheck';
+
+describe('Middleware - healthCheck', () => {
+  it('default healtcheck route', async () => {
+    const app = express();
+    app.use(healthCheck());
+    await request(app).get('/').expect(200);
+    await request(app).get('/heartbeat').expect(200);
+  });
+});

package/src/middleware/healthCheck/healthCheck.ts

@@ -1,14 +1,14 @@
-import { Router, Request, Response } from 'express';
-
-/**
- * respond to Kubernetes health-checks with 200
- */
-export function healthCheck(path = '/heartbeat'): Router {
-  return Router()
-    .get('/', (req: Request, res: Response) => {
-      res.sendStatus(200);
-    })
-    .get(path, (req: Request, res: Response) => {
-      res.sendStatus(200);
-    });
-}
+import { Router, Request, Response } from 'express';
+
+/**
+ * respond to Kubernetes health-checks with 200
+ */
+export function healthCheck(path = '/heartbeat'): Router {
+  return Router()
+    .get('/', (req: Request, res: Response) => {
+      res.sendStatus(200);
+    })
+    .get(path, (req: Request, res: Response) => {
+      res.sendStatus(200);
+    });
+}

package/src/middleware/healthCheck/index.ts

@@ -1 +1 @@
-export * from './healthCheck';
+export * from './healthCheck';

package/src/middleware/index.ts

@@ -1,17 +1,17 @@
-export * from './error';
-export * from './healthCheck';
-export * from './validate';
-export * from './fourOhFour';
-export * from './authJwt';
-export * from './authHmac';
-export * from './authStatic';
-export * from './swaggerDocs';
-export * from './authTls';
-export * from './userResolver';
-export * from './fileUploader';
-export * from './metrics';
-export * from './requestMetrics';
-export * from './version';
-export * from './authAdmin';
-export * from './geminiFileUploader';
-export * from './checkPermission';
+export * from './error';
+export * from './healthCheck';
+export * from './validate';
+export * from './fourOhFour';
+export * from './authJwt';
+export * from './authHmac';
+export * from './authStatic';
+export * from './swaggerDocs';
+export * from './authTls';
+export * from './userResolver';
+export * from './fileUploader';
+export * from './metrics';
+export * from './requestMetrics';
+export * from './version';
+export * from './authAdmin';
+export * from './geminiFileUploader';
+export * from './checkPermission';

package/src/middleware/metrics/index.ts

@@ -1 +1 @@
-export * from './metrics';
+export * from './metrics';