create-weave-backend-app 0.1.0

package/template/+express+azure-web-pubsub/src/store.ts

@@ -0,0 +1,77 @@
+import path from 'path';
+import fs from 'fs/promises';
+import { WeaveAzureWebPubsubServer } from '@inditextech/weave-store-azure-web-pubsub/server';
+import { createFolder, existsFolder } from '@/utils';
+
+const endpoint = process.env.WEAVE_AZURE_WEB_PUBSUB_ENDPOINT;
+const key = process.env.WEAVE_AZURE_WEB_PUBSUB_KEY;
+const hubName = process.env.WEAVE_AZURE_WEB_PUBSUB_HUB_NAME;
+
+if (!endpoint || !key || !hubName) {
+  throw new Error('Missing required environment variables');
+}
+
+let azureWebPubsubServer: WeaveAzureWebPubsubServer | null = null;
+
+export const getAzureWebPubsubServer = () => {
+  if (!azureWebPubsubServer) {
+    throw new Error('Azure Web Pubsub server not initialized');
+  }
+
+  return azureWebPubsubServer;
+};
+
+export const setupStore = () => {
+  azureWebPubsubServer = new WeaveAzureWebPubsubServer({
+    pubsubConfig: {
+      endpoint,
+      key,
+      hubName,
+    },
+    fetchRoom: async (docName: string) => {
+      try {
+        const roomsFolder = path.join(__dirname, 'rooms');
+
+        if (!(await existsFolder(roomsFolder))) {
+          await createFolder(roomsFolder);
+        }
+
+        const roomsFile = path.join(roomsFolder, docName);
+        return await fs.readFile(roomsFile);
+      } catch (ex) {
+        console.error(ex);
+        return null;
+      }
+    },
+    persistRoom: async (
+      docName: string,
+      actualState: Uint8Array<ArrayBufferLike>
+    ) => {
+      try {
+        const roomsFolder = path.join(__dirname, 'rooms');
+
+        if (!(await existsFolder(roomsFolder))) {
+          await createFolder(roomsFolder);
+        }
+
+        let folderExists = false;
+        try {
+          await fs.access(roomsFolder);
+          folderExists = true;
+          // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        } catch (e) {
+          folderExists = false;
+        }
+
+        if (!folderExists) {
+          await fs.mkdir(roomsFolder, { recursive: true });
+        }
+
+        const roomsFile = path.join(roomsFolder, docName);
+        await fs.writeFile(roomsFile, actualState);
+      } catch (ex) {
+        console.error(ex);
+      }
+    },
+  });
+};

package/template/+express+azure-web-pubsub/src/types.ts

@@ -0,0 +1,6 @@
+export type ServiceConfig = {
+  service: {
+    hostname: string;
+    port: number;
+  };
+};

package/template/+express+azure-web-pubsub/src/utils.ts

@@ -0,0 +1,33 @@
+import fs from 'fs/promises';
+
+export const getFileContents = async (
+  filePath: string,
+  encoding: BufferEncoding = 'utf-8',
+): Promise<string> => {
+  try {
+    const content = await fs.readFile(filePath, { encoding });
+    return content;
+  } catch (err) {
+    console.error(
+      `Error reading file ${filePath}: ${err instanceof Error ? err.message : err}`,
+    );
+    throw err;
+  }
+};
+
+export const existsFolder = async (folderPath: string) => {
+  try {
+    const stats = await fs.stat(folderPath);
+    return stats.isDirectory();
+  } catch (err) {
+    return false;
+  }
+};
+
+export const createFolder = async (folderPath: string): Promise<void> => {
+  try {
+    await fs.mkdir(folderPath, { recursive: true });
+  } catch (err) {
+    throw err;
+  }
+};

package/template/+express+azure-web-pubsub/src/validate.ts

@@ -0,0 +1,22 @@
+import { ZodError } from "zod";
+import { getServiceConfig } from "./config/config.js";
+import { ServiceConfig } from "./types.js";
+import { getLogger } from "./logger/logger.js";
+
+export function validateServiceConfig() {
+  let config: ServiceConfig | null = null;
+  const logger = getLogger().child({ module: "validate" });
+
+  try {
+    config = getServiceConfig();
+  } catch (ex) {
+    // console.log(ex);
+    if (ex instanceof ZodError) {
+      for (const issue of ex.issues) {
+        logger.error(issue.message);
+      }
+    }
+  }
+
+  return config;
+}

package/template/+express+azure-web-pubsub/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "NodeNext",
+    "rootDir": "./src",
+    "moduleResolution": "nodenext",
+    "outDir": "./dist",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  }
+}

package/template/+express+websockets/README.md

@@ -0,0 +1,38 @@
+# Weave.js Backend start template
+
+This is an Express.js application that was generated with **Create Weave.js Backend**
+
+This server setup the Weave.js
+[Azure WebSockets](https://inditextech.github.io/weavejs/docs/main/build/stores/websockets-store) store. No extra setup needed.
+
+## Quickstart
+
+If you skipped the automatic installation of the dependencies, run first this
+command:
+
+```bash
+npm install
+# or
+pnpm install
+# or
+yarn install
+```
+
+Now, lets run the development server:
+
+```bash
+npm run dev
+# or
+pnpm dev
+# or
+yarn dev
+```
+
+## Learn more
+
+To learn more about Express.js and Weave.js, take a look at the following
+resources:
+
+- [Express.js](https://expressjs.com/) - learn about Express.js
+- [Weave.js](https://inditextech.github.io/weavejs) - learn about Weave.js
+- [Weave.js repository](https://github.com/InditexTech/weavejs) - check out out code.

package/template/+express+websockets/eslint.config.js

@@ -0,0 +1,11 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  {files: ["**/*.{js,mjs,cjs,ts}"], ignores: ["dist/**/*"],},
+  {languageOptions: { globals: globals.node }},
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+];

package/template/+express+websockets/example.env

@@ -0,0 +1,3 @@
+HOSTNAME=0.0.0.0
+PORT=8080
+LOG_LEVEL=debug

package/template/+express+websockets/example.gitignore

@@ -0,0 +1,37 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+reports
+
+node_modules
+dist
+dist-ssr
+*.local
+vite.config.ts*
+!vite.config.ts
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+*.pem
+.env*
+.npmrc
+
+images
+images-mimetype
+rooms
+temp
+public

package/template/+express+websockets/src/api/v1/controllers/delImage.ts

@@ -0,0 +1,22 @@
+import { Request, Response } from "express";
+import { ImagesPersistenceHandler } from "../../../images/persistence.js";
+
+export const delImageController = () => {
+  const persistenceHandler = new ImagesPersistenceHandler()
+
+  return async (req: Request, res: Response): Promise<void> => {
+    const roomId = req.params.roomId;
+    const imageId = req.params.imageId;
+
+    const fileName = `${roomId}/${imageId}`;
+
+    const result = await persistenceHandler.delete(fileName);
+
+    if (result) {
+      res.status(200).json({ status: "KO", message: "Image deleted" });
+      return;
+    }
+
+    res.status(404).json({ status: "KO", message: "Image not found" });
+  };
+}

package/template/+express+websockets/src/api/v1/controllers/getHealth.ts

@@ -0,0 +1,5 @@
+import { Request, Response } from "express";
+
+export const getHealthController = () => (req: Request, res: Response): void => {
+  res.status(200).json({ status: "OK" });
+};

package/template/+express+websockets/src/api/v1/controllers/getImage.ts

@@ -0,0 +1,35 @@
+import { Request, Response } from 'express';
+import { ImagesPersistenceHandler } from '../../../images/persistence.js';
+
+export const getImageController = () => {
+  const persistenceHandler = new ImagesPersistenceHandler();
+
+  return async (req: Request, res: Response): Promise<void> => {
+    const roomId = req.params.roomId;
+    const imageId = req.params.imageId;
+
+    const fileName = `${roomId}/${imageId}`;
+
+    if (!(await persistenceHandler.exists(fileName))) {
+      res.status(404).json({ status: 'KO', message: "Image doesn't exists" });
+      return;
+    }
+
+    const filePath = await persistenceHandler.getFilePath(fileName);
+
+    if (filePath) {
+      const mimeType = await persistenceHandler.getMimeType(fileName);
+      res.setHeader('Content-Type', mimeType);
+      res.sendFile(filePath, (err) => {
+        if (err) {
+          console.error('File not found or error sending file:', err.message);
+          res.status(404).send('Image not found');
+        }
+      });
+    } else {
+      res
+        .status(500)
+        .json({ status: 'KO', message: 'Error downloading image' });
+    }
+  };
+};

package/template/+express+websockets/src/api/v1/controllers/getImages.ts

@@ -0,0 +1,19 @@
+import { Request, Response } from 'express';
+import { ImagesPersistenceHandler } from '../../../images/persistence.js';
+
+export const getImagesController = () => {
+  const persistenceHandler = new ImagesPersistenceHandler();
+
+  return async (req: Request, res: Response): Promise<void> => {
+    const roomId = req.params.roomId;
+
+    const pageSize = parseInt(
+      (req.query.pageSize as string | undefined) ?? '20',
+    );
+    const page = parseInt((req.query.page as string | undefined) ?? '1');
+
+    const images = await persistenceHandler.list(roomId, pageSize, page);
+
+    res.status(200).json(images);
+  };
+};

package/template/+express+websockets/src/api/v1/controllers/getRoomConnect.ts

@@ -0,0 +1,9 @@
+import { Request, Response } from 'express';
+
+export const getRoomConnectController =
+  () =>
+  async (req: Request, res: Response): Promise<void> => {
+    const roomId = req.params.roomId;
+
+    res.status(200).json({ roomId });
+  };

package/template/+express+websockets/src/api/v1/controllers/postRemoveBackground.ts

@@ -0,0 +1,60 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { Request, Response } from 'express';
+import { removeBackground } from '@imgly/background-removal-node';
+import { ImagesPersistenceHandler } from '../../../images/persistence.js';
+
+async function myBlobToUIntDemo(blob: Blob) {
+  const arrayBuffer = await blob.arrayBuffer();
+  const buffer = Buffer.from(arrayBuffer);
+  return new Uint8Array(buffer);
+}
+
+export const postRemoveBackgroundController = () => {
+  const persistenceHandler = new ImagesPersistenceHandler();
+
+  return async (req: Request, res: Response): Promise<void> => {
+    const roomId = req.params.roomId;
+    const imageId = req.params.imageId;
+
+    const fileName = `${roomId}/${imageId}`;
+
+    if (!(await persistenceHandler.exists(fileName))) {
+      res.status(404).json({ status: 'KO', message: "Image doesn't exists" });
+      return;
+    }
+
+    try {
+      const filePathDownload = await persistenceHandler.getFilePath(fileName);
+
+      removeBackground(filePathDownload, {
+        publicPath: `file://${path.join(process.cwd(), 'public')}/`,
+        output: { format: 'image/png', quality: 1 },
+      })
+        .then(async (blob: Blob) => {
+          // The result is a blob encoded as PNG. It can be converted to an URL to be used as HTMLImage.src
+          const data = await myBlobToUIntDemo(blob);
+          const fileNameRemoved = `${fileName}-removed`;
+          await persistenceHandler.persist(fileNameRemoved, 'image/png', data);
+          fs.rmSync(filePathDownload);
+
+          res.status(201).json({
+            status: 'Image created OK',
+            fileName: fileNameRemoved,
+            mimeType: 'image/png',
+          });
+        })
+        .catch((err) => {
+          console.error(err);
+          res
+            .status(500)
+            .json({ status: 'KO', message: 'Error transforming the image' });
+        });
+    } catch (ex) {
+      console.error(ex);
+      res
+        .status(500)
+        .json({ status: 'KO', message: 'Error downloading the image' });
+    }
+  };
+};

package/template/+express+websockets/src/api/v1/controllers/postUploadImage.ts

@@ -0,0 +1,35 @@
+import { Request, Response } from 'express';
+import { v4 as uuidv4 } from 'uuid';
+import { ImagesPersistenceHandler } from '../../../images/persistence.js';
+
+export const postUploadImageController = () => {
+  const persistenceHandler = new ImagesPersistenceHandler();
+
+  return async (req: Request, res: Response): Promise<void> => {
+    const file = req.file;
+
+    const roomId = req.params.roomId;
+    const mimeType = file?.mimetype ?? 'application/octet-stream';
+    const data = file?.buffer ?? new Uint8Array();
+
+    const fileName = `${roomId}/${uuidv4()}`;
+
+    if (await persistenceHandler.exists(fileName)) {
+      res.status(500).json({ status: 'KO', message: 'Image already exists' });
+    }
+
+    try {
+      if (file) {
+        await persistenceHandler.persist(fileName, mimeType, data);
+        res
+          .status(201)
+          .json({ status: 'Image created OK', fileName, mimeType });
+      } else {
+        res.status(500).json({ status: 'KO', message: 'Error creating image' });
+      }
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    } catch (error) {
+      res.status(500).json({ status: 'KO', message: 'Error creating image' });
+    }
+  };
+};

package/template/+express+websockets/src/api/v1/router.ts

@@ -0,0 +1,44 @@
+import { Express, Router } from 'express';
+import multer from 'multer';
+import { getHealthController } from './controllers/getHealth.js';
+import { getRoomConnectController } from './controllers/getRoomConnect.js';
+import { getImageController } from './controllers/getImage.js';
+import { postUploadImageController } from './controllers/postUploadImage.js';
+import { delImageController } from './controllers/delImage.js';
+import { getImagesController } from './controllers/getImages.js';
+import { postRemoveBackgroundController } from './controllers/postRemoveBackground.js';
+
+const router: Router = Router();
+
+export function getApiV1Router() {
+  return router;
+}
+
+export function setupApiV1Router(app: Express) {
+  const router: Router = Router();
+
+  // Setup multer to upload files
+  const upload = multer();
+
+  // Setup router routes
+  router.get(`/health`, getHealthController());
+
+  // Room handling API
+  router.get(`/sync/rooms/:roomId`, getRoomConnectController());
+
+  // Images handling API
+  router.get(`/rooms/:roomId/images`, getImagesController());
+  router.get(`/rooms/:roomId/images/:imageId`, getImageController());
+  router.post(
+    `/rooms/:roomId/images/:imageId/remove-background`,
+    postRemoveBackgroundController(),
+  );
+  router.post(
+    `/rooms/:roomId/images`,
+    upload.single('file'),
+    postUploadImageController(),
+  );
+  router.delete(`/rooms/:roomId/images/:imageId`, delImageController());
+
+  app.use('/api/v1', router);
+}

package/template/+express+websockets/src/app.ts

@@ -0,0 +1,32 @@
+import express, { type Express } from "express";
+import { setupHttpLoggerMiddleware } from "./middlewares/http-logger.js";
+import { setupCorsMiddleware } from "./middlewares/cors.js";
+import { setupHttpResponseHeadersMiddleware } from "./middlewares/http-response-headers.js";
+import { setupBodyParserMiddleware } from "./middlewares/body-parser.js";
+import { setupApiV1Router } from "./api/v1/router.js";
+
+let app: Express | null = null;
+
+export function getApp() {
+  if (!app) {
+    throw new Error("App not initialized");
+  }
+
+  return app;
+}
+
+export function setupApp() {
+  // Setup the service
+  app = express();
+
+  // Setup Middlewares
+  setupHttpLoggerMiddleware(app);
+  setupCorsMiddleware(app);
+  setupHttpResponseHeadersMiddleware(app);
+  setupBodyParserMiddleware(app);
+
+  // Setup Routers
+  setupApiV1Router(app);
+
+  return app;
+}

package/template/+express+websockets/src/config/config.ts

@@ -0,0 +1,38 @@
+import { z } from 'zod';
+import { ServiceConfig } from '../types.js';
+import { DEFAULT_PORT } from '../constants.js';
+
+const serviceConfigSchema = z.object({
+  service: z.object({
+    hostname: z
+      .string({
+        required_error:
+          'Define the service hostname on the environment variable HOSTNAME',
+      })
+      .trim()
+      .optional()
+      .default('0.0.0.0'),
+    port: z
+      .number({
+        required_error:
+          'Define the service port on the environment variable PORT',
+      })
+      .int({ message: 'The post must be an integer' })
+      .optional()
+      .default(DEFAULT_PORT),
+  }),
+});
+
+export function getServiceConfig(): ServiceConfig {
+  const hostname = process.env.HOSTNAME;
+  const port = parseInt(process.env.PORT || `${DEFAULT_PORT}`);
+
+  const service = {
+    hostname,
+    port,
+  };
+
+  const serviceConfig = { service };
+
+  return serviceConfigSchema.parse(serviceConfig);
+}

package/template/+express+websockets/src/constants.ts

@@ -0,0 +1 @@
+export const DEFAULT_PORT = 3000;