@unchainedshop/plugins 4.3.5 → 4.4.0

package/src/files/gridfs/adapter.ts

@@ -1,176 +0,0 @@
-import { Readable, PassThrough } from 'node:stream';
-import { finished, pipeline } from 'node:stream/promises';
-import mime from 'mime/lite';
-import {
-  FileAdapter,
-  FileDirector,
-  buildHashedFilename,
-  resolveExpirationDate,
-  IFileAdapter,
-} from '@unchainedshop/file-upload';
-import { UploadFileData } from '@unchainedshop/file-upload';
-import sign from './sign.js';
-import { filesSettings } from '@unchainedshop/core-files';
-import { UnchainedCore } from '@unchainedshop/core';
-import { GridFSFileUploadsModule } from './index.js';
-
-const { GRIDFS_PUT_SERVER_PATH = '/gridfs' } = process.env;
-
-const { ROOT_URL } = process.env;
-
-const bufferToStream = (buffer: any) => {
-  const stream = new Readable();
-  stream.push(buffer);
-  stream.push(null);
-
-  return stream;
-};
-
-export const GridFSAdapter: IFileAdapter<
-  UnchainedCore & {
-    modules: GridFSFileUploadsModule;
-  }
-> = {
-  key: 'shop.unchained.file-upload-plugin.gridfs',
-  label: 'Uploads files to Database using GridFS',
-  version: '1.0.0',
-
-  ...FileAdapter,
-  async createDownloadURL(file, expiry) {
-    // If public, just return the stored path from the db
-    if (!file?.meta?.isPrivate) return file?.url || null;
-
-    const expiryTimestamp =
-      expiry ||
-      new Date(new Date().getTime() + (filesSettings?.privateFileSharingMaxAge || 0)).getTime();
-
-    const signature = await sign(file.path, file._id, expiryTimestamp);
-    return `${file.url}?s=${signature}&e=${expiryTimestamp}`;
-  },
-  async createSignedURL(directoryName, fileName) {
-    const expiryDate = resolveExpirationDate();
-    const hashedFilename = await buildHashedFilename(directoryName, fileName, expiryDate);
-    const signature = await sign(directoryName, hashedFilename, expiryDate.getTime());
-
-    const putURL = new URL(
-      `${GRIDFS_PUT_SERVER_PATH}/${directoryName}/${encodeURIComponent(
-        fileName,
-      )}?e=${expiryDate.getTime()}&s=${signature}`,
-      ROOT_URL,
-    ).href;
-    const url = `${GRIDFS_PUT_SERVER_PATH}/${directoryName}/${hashedFilename}`;
-
-    return {
-      _id: hashedFilename,
-      directoryName,
-      expiryDate,
-      fileName,
-      type: mime.getType(fileName),
-      putURL,
-      url,
-    } as UploadFileData & { putURL: string };
-  },
-
-  async uploadFileFromStream(directoryName: string, rawFile: any, { modules }, options = {}) {
-    let stream: Readable;
-    let fileName;
-    let fileId;
-    if (rawFile instanceof Promise) {
-      const { filename: f, createReadStream, fileId: forcedFileId } = await rawFile;
-      fileName = decodeURIComponent(f);
-      stream = createReadStream();
-      fileId = forcedFileId;
-    } else {
-      fileName = decodeURIComponent(rawFile.filename);
-      stream = bufferToStream(Buffer.from(rawFile.buffer, 'base64'));
-      fileId = rawFile.fileId;
-    }
-
-    const expiryDate = resolveExpirationDate();
-    const hashedFilename = await buildHashedFilename(directoryName, fileName, expiryDate);
-    const type = mime.getType(fileName) || (await Promise.resolve(rawFile)).mimetype;
-
-    const writeStream = await modules.gridfsFileUploads.createWriteStream(
-      directoryName,
-      fileId || hashedFilename,
-      fileName,
-      {
-        metadata: { 'content-type': type },
-        chunkSizeBytes: 1024 * 1024, // 1MB
-        ...options,
-      },
-    );
-
-    await pipeline(
-      stream,
-      new PassThrough({ highWaterMark: 1024 * 1024 * 4 }), // 4MB Buffer
-      writeStream,
-    );
-
-    await finished(writeStream, { readable: false });
-
-    const { length } = writeStream;
-    const url = `${GRIDFS_PUT_SERVER_PATH}/${directoryName}/${encodeURIComponent(hashedFilename)}`;
-
-    return {
-      _id: fileId || hashedFilename,
-      directoryName,
-      expiryDate: null,
-      fileName,
-      size: length,
-      type,
-      url,
-    } as UploadFileData;
-  },
-
-  async uploadFileFromURL(
-    directoryName: string,
-    { fileLink, fileName: fname, fileId, headers }: any,
-    { modules },
-  ) {
-    const { href } = new URL(fileLink);
-    const fileName = decodeURIComponent(fname || href.split('/').pop());
-
-    const expiryDate = resolveExpirationDate();
-    const hashedFilename = await buildHashedFilename(directoryName, fileName, expiryDate);
-
-    const response = await fetch(href, { headers });
-    if (!response.ok) throw new Error(`Unexpected response for ${href}: ${response.statusText}`);
-    const type = mime.getType(fileName) || response.headers.get('content-type');
-
-    const writeStream = await modules.gridfsFileUploads.createWriteStream(
-      directoryName,
-      fileId || hashedFilename,
-      fileName,
-      {
-        metadata: { 'content-type': type },
-      },
-    );
-    await pipeline(response.body as unknown as Readable, new PassThrough(), writeStream);
-    const { length } = writeStream;
-    const url = `${GRIDFS_PUT_SERVER_PATH}/${directoryName}/${encodeURIComponent(hashedFilename)}`;
-
-    return {
-      _id: fileId || hashedFilename,
-      directoryName,
-      expiryDate: null,
-      fileName,
-      size: length,
-      type,
-      url,
-    } as UploadFileData;
-  },
-
-  async createDownloadStream(file, { modules }: any) {
-    const readStream = await modules.gridfsFileUploads.createReadStream(file.path, file._id);
-    return readStream;
-  },
-
-  async removeFiles(files, { modules }: any) {
-    await Promise.all(
-      files.map(async ({ _id, path }) => modules.gridfsFileUploads.removeFileFromBucket(path, _id)),
-    );
-  },
-};
-
-FileDirector.registerAdapter(GridFSAdapter);

package/src/files/gridfs/handler-express.ts

@@ -1,145 +0,0 @@
-import { pipeline, finished } from 'node:stream/promises';
-import { PassThrough } from 'node:stream';
-import { buildHashedFilename } from '@unchainedshop/file-upload';
-import express from 'express';
-import sign from './sign.js';
-import { GridFSFileUploadsModule } from './module.js';
-import { Context } from '@unchainedshop/api';
-import { createLogger } from '@unchainedshop/logger';
-import { getFileAdapter } from '@unchainedshop/core-files';
-
-const { ROOT_URL, GRIDFS_PUT_SERVER_PATH = '/gridfs' } = process.env;
-
-const logger = createLogger('unchained:gridfs');
-
-const gridfsHandler = async (
-  req: express.Request & {
-    unchainedContext: Context & {
-      modules: GridFSFileUploadsModule;
-    };
-  },
-  res: express.Response,
-) => {
-  try {
-    const { services, modules } = req.unchainedContext;
-    const url = new URL(req.url, ROOT_URL);
-    const [, directoryNameRaw, fileNameRaw] = url.pathname.split('/');
-    const directoryName = decodeURIComponent(directoryNameRaw);
-    const fileName = decodeURIComponent(fileNameRaw);
-
-    /* This is a file upload endpoint, and thus we need to allow CORS.
-    else we'd need proxies for all kinds of things for storefronts */
-    res.setHeader('Access-Control-Allow-Methods', 'GET, PUT');
-    res.setHeader('Access-Control-Allow-Headers', 'Content-Type');
-    res.setHeader('Access-Control-Allow-Origin', '*');
-
-    if (req.method === 'OPTIONS') {
-      res.status(200).end();
-      return;
-    }
-
-    if (req.method === 'PUT') {
-      const { s: signature, e: expiryTimestamp } = req.query;
-      const expiryDate = new Date(parseInt(expiryTimestamp as string, 10));
-      const fileId = await buildHashedFilename(directoryName, fileName, expiryDate);
-      if ((await sign(directoryName, fileId, expiryDate.getTime())) === signature) {
-        const file = await modules.files.findFile({ fileId });
-
-        if (!file) {
-          res.status(404).send('File not found');
-          return;
-        }
-
-        if (file.expires === null) {
-          res.status(400).send('File already linked');
-          return;
-        }
-        // If the type is octet-stream, prefer mimetype lookup from the filename
-        // Else prefer the content-type header
-        const type =
-          req.header('Content-Type') === 'application/octet-stream'
-            ? file.type || req.header('Content-Type')
-            : req.header('Content-Type') || file.type;
-
-        const writeStream = await modules.gridfsFileUploads.createWriteStream(
-          directoryName,
-          fileId,
-          fileName,
-          {
-            chunkSizeBytes: 1024 * 1024, // 1MB
-            metadata: { 'content-type': type },
-          },
-        );
-        await pipeline(
-          req,
-          new PassThrough({ highWaterMark: 1024 * 1024 * 4 }), // 4MB Buffer
-          writeStream,
-        );
-
-        await finished(writeStream, { readable: false });
-
-        const { length } = writeStream;
-        await services.files.linkFile({ fileId, size: length, type });
-
-        res.status(200).end();
-        return;
-      }
-      res.status(403).end();
-      return;
-    }
-
-    if (req.method === 'GET') {
-      const { s: signature, e: expiryTimestamp } = req.query;
-      const fileDocument = await modules.files.findFile({
-        url: `${GRIDFS_PUT_SERVER_PATH}/${directoryName}/${fileName}`,
-      });
-      if (fileDocument?.meta?.isPrivate) {
-        const expiry = parseInt(expiryTimestamp as string, 10);
-        if (expiry <= Date.now()) {
-          res.status(403).send('Access restricted: Expired.');
-          return;
-        }
-
-        const fileUploadAdapter = getFileAdapter();
-        const signedUrl = await fileUploadAdapter.createDownloadURL(fileDocument, expiry);
-
-        if (!signedUrl || new URL(signedUrl, 'file://').searchParams.get('s') !== signature) {
-          res.status(403).send('Access restricted: Invalid signature.');
-          return;
-        }
-      } else if (!fileDocument) {
-        res.status(404).end();
-        return;
-      }
-
-      const file = await modules.gridfsFileUploads.getFileInfo(directoryName, fileDocument._id);
-
-      if (file?.metadata?.['content-type']) {
-        res.setHeader('Content-Type', file.metadata['content-type']);
-      }
-      if (file?.length) {
-        res.setHeader('Content-Length', file?.length.toString());
-      }
-
-      const readStream = await modules.gridfsFileUploads.createReadStream(
-        directoryName,
-        fileDocument._id,
-      );
-      readStream.pipe(res, { end: false });
-      await finished(readStream);
-      res.status(200).end();
-      return;
-    }
-    res.status(404).end();
-  } catch (e) {
-    if (e.code === 'ENOENT') {
-      logger.warn(e);
-      res.status(404).send();
-    } else {
-      logger.warn(e);
-      res.status(503).send({ name: e.name, code: e.code, message: e.message });
-    }
-  }
-};
-
-export default gridfsHandler;

package/src/files/gridfs/handler-fastify.ts

@@ -1,177 +0,0 @@
-import { finished, pipeline } from 'node:stream/promises';
-import { PassThrough } from 'node:stream';
-import { FastifyRequest, RouteHandlerMethod } from 'fastify';
-import { buildHashedFilename } from '@unchainedshop/file-upload';
-import sign from './sign.js';
-import { GridFSFileUploadsModule } from './module.js';
-import { Context } from '@unchainedshop/api';
-import { createLogger } from '@unchainedshop/logger';
-import { getFileAdapter } from '@unchainedshop/core-files';
-
-const logger = createLogger('unchained:gridfs');
-
-const { GRIDFS_PUT_SERVER_PATH = '/gridfs' } = process.env;
-
-const gridfsHandler: RouteHandlerMethod = async (
-  req: FastifyRequest & {
-    unchainedContext: Context & {
-      modules: GridFSFileUploadsModule;
-    };
-  },
-  reply,
-) => {
-  try {
-    const { services, modules } = req.unchainedContext;
-    const { directoryName, fileName } = req.params as any;
-
-    /* This is a file upload endpoint, and thus we need to allow CORS.
-    else we'd need proxies for all kinds of things for storefronts */
-    reply.header('Access-Control-Allow-Methods', 'GET, PUT');
-    reply.header('Access-Control-Allow-Headers', 'content-type');
-    reply.header('Access-Control-Allow-Origin', '*');
-
-    if (req.method === 'OPTIONS') {
-      reply.status(200);
-      return reply.send();
-    }
-
-    if (req.method === 'PUT') {
-      const { s: signature, e: expiryTimestamp } = req.query as Record<string, string>;
-      const expiryDate = new Date(parseInt(expiryTimestamp as string, 10));
-      const fileId = await buildHashedFilename(directoryName, fileName, expiryDate);
-      if ((await sign(directoryName, fileId, expiryDate.getTime())) === signature) {
-        const file = await modules.files.findFile({ fileId });
-
-        if (!file) {
-          reply.status(404);
-          logger.error('File not found', { fileId });
-          return reply.send({
-            success: false,
-            message: 'File not found',
-            name: 'FILE_NOT_FOUND',
-          });
-        }
-
-        if (file.expires === null) {
-          reply.status(400);
-          logger.error('File already linked', { fileId });
-          return reply.send({
-            success: false,
-            message: 'File already linked',
-            name: 'FILE_ALREADY_LINKED',
-          });
-        }
-        // If the type is octet-stream, prefer mimetype lookup from the filename
-        // Else prefer the content-type header
-        const type =
-          req.headers['content-type'] === 'application/octet-stream'
-            ? file.type || (req.headers['content-type'] as string)
-            : (req.headers['content-type'] as string) || file.type;
-
-        const writeStream = await modules.gridfsFileUploads.createWriteStream(
-          directoryName,
-          fileId,
-          fileName,
-          {
-            chunkSizeBytes: 1024 * 1024, // 1MB
-            metadata: { 'content-type': type },
-          },
-        );
-
-        await pipeline(
-          req.raw,
-          new PassThrough({ highWaterMark: 1024 * 1024 * 4 }), // 4MB Buffer
-          writeStream,
-        );
-
-        await finished(writeStream, { readable: false });
-
-        const { length } = writeStream;
-        await services.files.linkFile({ fileId, size: length, type });
-
-        reply.status(200);
-        return reply.send({
-          success: true,
-          fileId,
-          size: length,
-          type,
-        });
-      }
-      logger.error('Invalid signature', { fileId, expiryDate });
-      reply.status(403);
-      return reply.send({
-        success: false,
-        message: 'Access restricted: Invalid signature.',
-        name: 'INVALID_SIGNATURE',
-      });
-    }
-
-    if (req.method === 'GET') {
-      const { s: signature, e: expiryTimestamp } = req.query as Record<string, string>;
-      const fileDocument = await modules.files.findFile({
-        url: `${GRIDFS_PUT_SERVER_PATH}/${directoryName}/${fileName}`,
-      });
-      if (fileDocument?.meta?.isPrivate) {
-        const expiry = parseInt(expiryTimestamp as string, 10);
-        if (expiry <= Date.now()) {
-          logger.error('URL Expired', { fileName, expiry });
-          reply.status(403);
-          return reply.send({
-            success: false,
-            message: 'Access restricted: URL expired.',
-            name: 'URL_EXPIRED',
-          });
-        }
-
-        const fileUploadAdapter = getFileAdapter();
-        const signedUrl = await fileUploadAdapter.createDownloadURL(fileDocument, expiry);
-
-        if (!signedUrl || new URL(signedUrl, 'file://').searchParams.get('s') !== signature) {
-          reply.status(403);
-          logger.error('Invalid signature', { fileName, expiry });
-          return reply.send({
-            success: false,
-            message: 'Access restricted: Invalid signature.',
-            name: 'INVALID_SIGNATURE',
-          });
-        }
-      } else if (!fileDocument) {
-        logger.error('File not found', { fileName });
-        reply.status(404);
-        return reply.send();
-      }
-
-      const file = await modules.gridfsFileUploads.getFileInfo(directoryName, fileDocument._id);
-
-      if (file?.metadata?.['content-type']) {
-        reply.header('content-type', file.metadata['content-type']);
-      }
-      if (file?.length) {
-        reply.header('content-length', file?.length.toString());
-      }
-
-      const readStream = await modules.gridfsFileUploads.createReadStream(
-        directoryName,
-        fileDocument._id,
-      );
-
-      reply.status(200);
-      return reply.send(readStream);
-    }
-
-    reply.status(404);
-    return reply.send();
-  } catch (e) {
-    logger.error(e);
-
-    if (e.code === 'ENOENT') {
-      reply.status(404);
-      return reply.send();
-    } else {
-      reply.status(504);
-      return reply.send({ success: false, name: e.name, code: e.code, message: e.message });
-    }
-  }
-};
-
-export default gridfsHandler;

package/src/files/gridfs/index.ts

@@ -1,6 +0,0 @@
-import './adapter.js';
-
-import gridfsModules, { type GridFSFileUploadsModule } from './module.js';
-
-export type { GridFSFileUploadsModule };
-export default gridfsModules;

package/src/files/gridfs/module.ts

@@ -1,54 +0,0 @@
-import { mongodb } from '@unchainedshop/mongodb';
-
-export const configureGridFSFileUploadModule = ({ db }) => {
-  // eslint-disable-next-line
-  let { GridFSBucket } = mongodb;
-
-  return {
-    createWriteStream: async (
-      directoryName,
-      fileId,
-      fileName,
-      uploadOptions: mongodb.GridFSBucketWriteStream['options'],
-    ) => {
-      const options = { bucketName: `file_uploads_${directoryName}` };
-      const bucket = new GridFSBucket(db, options);
-
-      if (fileId) {
-        try {
-          // Try removing the target if it already exists
-          await bucket.delete(fileId);
-        } catch {
-          /* */
-        }
-      }
-
-      return bucket.openUploadStreamWithId(fileId, fileName, uploadOptions);
-    },
-    getFileInfo: async (directoryName, fileId) => {
-      const options = { bucketName: `file_uploads_${directoryName}` };
-      const bucket = new GridFSBucket(db, options);
-      return bucket.find({ _id: fileId }).next();
-    },
-    createReadStream: async (directoryName, fileId) => {
-      const options = { bucketName: `file_uploads_${directoryName}` };
-      const bucket = new GridFSBucket(db, options);
-      return bucket.openDownloadStream(fileId);
-    },
-    removeFileFromBucket: async (directoryName, fileId) => {
-      const options = { bucketName: `file_uploads_${directoryName}` };
-      const bucket = new GridFSBucket(db, options);
-      return bucket.delete(fileId);
-    },
-  };
-};
-
-export default {
-  gridfsFileUploads: {
-    configure: configureGridFSFileUploadModule,
-  },
-};
-
-export interface GridFSFileUploadsModule {
-  gridfsFileUploads: ReturnType<typeof configureGridFSFileUploadModule>;
-}

package/src/files/gridfs/sign.ts

@@ -1,28 +0,0 @@
-const { UNCHAINED_GRIDFS_PUT_UPLOAD_SECRET } = process.env;
-
-const sign = async (directoryName, hash, expiryTimestamp) => {
-  if (!UNCHAINED_GRIDFS_PUT_UPLOAD_SECRET)
-    throw new Error(
-      'To enable PUT based uploads or signed downloads you have to provide a random UNCHAINED_GRIDFS_PUT_UPLOAD_SECRET environment variable',
-    );
-
-  const key = await crypto.subtle.importKey(
-    'raw',
-    new TextEncoder().encode(UNCHAINED_GRIDFS_PUT_UPLOAD_SECRET),
-    { name: 'HMAC', hash: 'SHA-256' },
-    false,
-    ['sign'],
-  );
-  const signatureBinary = await crypto.subtle.sign(
-    'HMAC',
-    key,
-    new TextEncoder().encode([directoryName, hash, expiryTimestamp].join(':')),
-  );
-
-  const hmacSubtle = Array.from(new Uint8Array(signatureBinary))
-    .map((byte) => byte.toString(16).padStart(2, '0'))
-    .join('');
-  return hmacSubtle;
-};
-
-export default sign;

package/src/files/minio/handler-express.ts

@@ -1,35 +0,0 @@
-import { createLogger } from '@unchainedshop/logger';
-
-const logger = createLogger('unchained:minio');
-
-const { MINIO_WEBHOOK_AUTH_TOKEN } = process.env;
-
-const isAuthorized = ({ authorization = '' }) => {
-  const [type, token] = authorization.split(' ');
-  return type === 'Bearer' && token === MINIO_WEBHOOK_AUTH_TOKEN;
-};
-
-const minioHandler = async (req, res) => {
-  try {
-    if (req.method === 'POST' && req.body) {
-      const { headers } = req;
-      const { Records = [], EventName } = req.body;
-      if (EventName === 's3:ObjectCreated:Put' && isAuthorized(headers)) {
-        const [{ s3 }] = Records;
-        const { object } = s3;
-        const { size, contentType: type } = object;
-        const [fileId] = object.key.split('.');
-        const { services } = req.unchainedContext;
-        await services.files.linkFile({ fileId, type, size });
-        res.status(200).end();
-        return;
-      }
-    }
-    res.status(404).end();
-  } catch (e) {
-    logger.error(e);
-    res.status(503).send({ name: e.name, code: e.code, message: e.message });
-  }
-};
-
-export default minioHandler;

package/src/files/minio/handler-fastify.ts

@@ -1,44 +0,0 @@
-import { Context } from '@unchainedshop/api';
-import { createLogger } from '@unchainedshop/logger';
-import { FastifyRequest, RouteHandlerMethod } from 'fastify';
-
-const logger = createLogger('unchained:minio');
-
-const { MINIO_WEBHOOK_AUTH_TOKEN } = process.env;
-
-const isAuthorized = ({ authorization = '' }) => {
-  const [type, token] = authorization.split(' ');
-  return type === 'Bearer' && token === MINIO_WEBHOOK_AUTH_TOKEN;
-};
-
-const minioHandler: RouteHandlerMethod = async (
-  req: FastifyRequest & {
-    unchainedContext: Context;
-  },
-  res,
-) => {
-  try {
-    if (req.body) {
-      const { headers } = req;
-      const { Records = [], EventName } = req.body as Record<string, any>;
-      if (EventName === 's3:ObjectCreated:Put' && isAuthorized(headers)) {
-        const [{ s3 }] = Records;
-        const { object } = s3;
-        const { size, contentType: type } = object;
-        const [fileId] = object.key.split('.');
-        const { services } = req.unchainedContext;
-        await services.files.linkFile({ fileId, type, size });
-        res.status(200);
-        return res.send();
-      }
-    }
-    res.status(404);
-    return res.send();
-  } catch (e) {
-    logger.error(e);
-    res.status(503);
-    return res.send({ name: e.name, code: e.code, message: e.message });
-  }
-};
-
-export default minioHandler;