@unchainedshop/plugins 3.0.0-rc.13 → 3.0.0-rc.15

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "@unchainedshop/plugins",
-  "version": "3.0.0-rc.13",
+  "version": "3.0.0-rc.15",
   "main": "lib/plugins-index.js",
   "types": "lib/plugins-index.d.ts",
   "exports": {
-    ".": "./lib/plugins-index.js",
     "./*": "./lib/*"
   },
   "type": "module",
@@ -36,22 +35,23 @@
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
     "@breejs/later": "^4.2.0",
-    "@unchainedshop/api": "^3.0.0-rc.13",
-    "@unchainedshop/core-delivery": "^3.0.0-rc.13",
-    "@unchainedshop/core-enrollments": "^3.0.0-rc.13",
-    "@unchainedshop/core-orders": "^3.0.0-rc.13",
-    "@unchainedshop/core-payment": "^3.0.0-rc.13",
-    "@unchainedshop/core-products": "^3.0.0-rc.13",
-    "@unchainedshop/core-warehousing": "^3.0.0-rc.13",
-    "@unchainedshop/core-worker": "^3.0.0-rc.13",
-    "@unchainedshop/events": "^3.0.0-rc.13",
-    "@unchainedshop/file-upload": "^3.0.0-rc.13",
-    "@unchainedshop/logger": "^3.0.0-rc.13",
-    "@unchainedshop/utils": "^3.0.0-rc.13",
+    "@unchainedshop/api": "^3.0.0-rc.15",
+    "@unchainedshop/core-delivery": "^3.0.0-rc.15",
+    "@unchainedshop/core-enrollments": "^3.0.0-rc.15",
+    "@unchainedshop/core-orders": "^3.0.0-rc.15",
+    "@unchainedshop/core-payment": "^3.0.0-rc.15",
+    "@unchainedshop/core-products": "^3.0.0-rc.15",
+    "@unchainedshop/core-warehousing": "^3.0.0-rc.15",
+    "@unchainedshop/core-worker": "^3.0.0-rc.15",
+    "@unchainedshop/events": "^3.0.0-rc.15",
+    "@unchainedshop/file-upload": "^3.0.0-rc.15",
+    "@unchainedshop/logger": "^3.0.0-rc.15",
+    "@unchainedshop/utils": "^3.0.0-rc.15",
     "event-iterator": "^2.0.0",
     "JSONStream": "^1.3.5"
   },
   "peerDependencies": {
+    "fastify": ">= 5.2 < 6",
     "@aws-sdk/client-eventbridge": ">= 3.714 < 4",
     "@paypal/checkout-server-sdk": "1.x",
     "@redis/client": "1.x",
@@ -97,6 +97,9 @@
     "express": {
       "optional": true
     },
+    "fastify": {
+      "optional": true
+    },
     "mime-types": {
       "optional": true
     },
@@ -143,6 +146,7 @@
     "ethers": "^6.13.4",
     "expiry-map": "^2.0.0",
     "express": "^5.0.1",
+    "fastify": "^5.2.0",
     "jest": "^29.7.0",
     "mime-types": "^2.1.35",
     "minio": "^8.0.3",

package/src/files/gridfs/{gridfs-adapter.ts → adapter.ts}

@@ -26,9 +26,7 @@ const bufferToStream = (buffer: any) => {
 
 export const GridFSAdapter: IFileAdapter<
   UnchainedCore & {
-    modules: {
-      gridfsFileUploads: GridFSFileUploadsModule;
-    };
+    modules: GridFSFileUploadsModule;
   }
 > = {
   key: 'shop.unchained.file-upload-plugin.gridfs',

package/src/files/gridfs/{gridfs-webhook.ts → handler-express.ts}

@@ -3,7 +3,7 @@ import { PassThrough } from 'node:stream';
 import { buildHashedFilename } from '@unchainedshop/file-upload';
 import express from 'express';
 import sign from './sign.js';
-import { configureGridFSFileUploadModule } from './index.js';
+import { GridFSFileUploadsModule } from './module.js';
 import { Context } from '@unchainedshop/api';
 import { createLogger } from '@unchainedshop/logger';
 import { getFileAdapter } from '@unchainedshop/core-files';
@@ -12,10 +12,10 @@ const { ROOT_URL } = process.env;
 
 const logger = createLogger('unchained:plugins:gridfs');
 
-export const gridfsHandler = async (
+const gridfsHandler = async (
   req: express.Request & {
     unchainedContext: Context & {
-      modules: { gridfsFileUploads: ReturnType<typeof configureGridFSFileUploadModule> };
+      modules: GridFSFileUploadsModule;
     };
   },
   res: express.Response,
@@ -127,3 +127,5 @@ export const gridfsHandler = async (
     }
   }
 };
+
+export default gridfsHandler;

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

@@ -0,0 +1,122 @@
+import { 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:plugins:gridfs');
+
+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.expires === null) {
+          reply.status(400);
+          return reply.send('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,
+          { 'content-type': type },
+        );
+
+        await pipeline(req.raw, new PassThrough(), writeStream);
+
+        const { length } = writeStream;
+        await services.files.linkFile({ fileId, size: length, type });
+
+        reply.status(200);
+        return reply.send();
+      }
+
+      reply.status(403);
+      return reply.send();
+    }
+
+    if (req.method === 'GET') {
+      const fileId = fileName;
+      const { s: signature, e: expiryTimestamp } = req.query as Record<string, string>;
+      const file = await modules.gridfsFileUploads.getFileInfo(directoryName, fileId);
+      const fileDocument = await modules.files.findFile({ fileId });
+      if (fileDocument?.meta?.isPrivate) {
+        const expiry = parseInt(expiryTimestamp as string, 10);
+        if (expiry <= Date.now()) {
+          reply.status(403);
+          return reply.send('Access restricted: Expired.');
+        }
+
+        const fileUploadAdapter = getFileAdapter();
+        const signedUrl = await fileUploadAdapter.createDownloadURL(fileDocument, expiry);
+
+        if (new URL(signedUrl, 'file://').searchParams.get('s') !== signature) {
+          reply.status(403);
+          return reply.send('Access restricted: Invalid signature.');
+        }
+      }
+
+      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, fileId);
+
+      reply.status(200);
+      return reply.send(readStream);
+    }
+
+    reply.status(404);
+    return reply.send();
+  } catch (e) {
+    if (e.code === 'ENOENT') {
+      logger.warn(e);
+      reply.status(404);
+      return reply.send({ name: e.name, code: e.code, message: e.message });
+    } else {
+      logger.warn(e);
+      reply.status(504);
+      return reply.send({ name: e.name, code: e.code, message: e.message });
+    }
+  }
+};
+
+export default gridfsHandler;

package/src/files/gridfs/index.ts

@@ -1,31 +1,6 @@
-import { mongodb } from '@unchainedshop/mongodb';
+import './adapter.js';
 
-export const configureGridFSFileUploadModule = ({ db }) => {
-  // eslint-disable-next-line
-  let { GridFSBucket } = mongodb;
+import gridfsModules, { type GridFSFileUploadsModule } from './module.js';
 
-  return {
-    createWriteStream: async (directoryName, fileId, fileName, metadata) => {
-      const options = { bucketName: `file_uploads_${directoryName}` };
-      const bucket = new GridFSBucket(db, options);
-      return bucket.openUploadStreamWithId(fileId, fileName, { metadata });
-    },
-    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 type GridFSFileUploadsModule = ReturnType<typeof configureGridFSFileUploadModule>;
+export type { GridFSFileUploadsModule };
+export default gridfsModules;

package/src/files/gridfs/module.ts

@@ -0,0 +1,39 @@
+import { mongodb } from '@unchainedshop/mongodb';
+
+export const configureGridFSFileUploadModule = ({ db }) => {
+  // eslint-disable-next-line
+  let { GridFSBucket } = mongodb;
+
+  return {
+    createWriteStream: async (directoryName, fileId, fileName, metadata) => {
+      const options = { bucketName: `file_uploads_${directoryName}` };
+      const bucket = new GridFSBucket(db, options);
+      return bucket.openUploadStreamWithId(fileId, fileName, { metadata });
+    },
+    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 type GridFSFileUploadsModule = {
+  gridfsFileUploads: ReturnType<typeof configureGridFSFileUploadModule>;
+};

package/src/files/minio/{minio-webhook.ts → handler-express.ts}

@@ -9,7 +9,7 @@ const isAuthorized = ({ authorization = '' }) => {
   return type === 'Bearer' && token === MINIO_WEBHOOK_AUTH_TOKEN;
 };
 
-export const minioHandler = async (req, res) => {
+const minioHandler = async (req, res) => {
   try {
     if (req.method === 'POST' && req.body) {
       const { headers } = req;
@@ -34,3 +34,5 @@ export const minioHandler = async (req, res) => {
     res.end(JSON.stringify({ name: e.name, code: e.code, message: e.message }));
   }
 };
+
+export default minioHandler;

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

@@ -0,0 +1,44 @@
+import { Context } from '@unchainedshop/api';
+import { createLogger } from '@unchainedshop/logger';
+import { FastifyRequest, RouteHandlerMethod } from 'fastify';
+
+const logger = createLogger('unchained:plugins: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(JSON.stringify({ name: e.name, code: e.code, message: e.message }));
+  }
+};
+
+export default minioHandler;

package/src/payment/apple-iap/adapter.ts

@@ -1,196 +1,11 @@
-import { Context } from '@unchainedshop/api';
-import { EnrollmentStatus } from '@unchainedshop/core-enrollments';
 import { IPaymentAdapter, PaymentAdapter, PaymentDirector, PaymentError } from '@unchainedshop/core';
 import { createLogger } from '@unchainedshop/logger';
-import { UnchainedCore } from '@unchainedshop/core';
-import { AppleTransactionsModule } from './module/configureAppleTransactionsModule.js';
+import { AppleTransactionsModule } from './module.js';
+import { verifyReceipt } from './verify-receipt.js';
 
 const logger = createLogger('unchained:core-payment:iap');
 
-const { APPLE_IAP_SHARED_SECRET, APPLE_IAP_ENVIRONMENT = 'sandbox' } = process.env;
-
-// https://developer.apple.com/documentation/storekit/in-app_purchase/validating_receipts_with_the_app_store
-const environments = {
-  sandbox: 'https://sandbox.itunes.apple.com/verifyReceipt',
-  production: 'https://buy.itunes.apple.com/verifyReceipt',
-};
-
-const verifyReceipt = async ({ receiptData, password }): Promise<any> => {
-  const payload: any = {
-    'receipt-data': receiptData,
-  };
-  if (password) {
-    payload.password = password;
-  }
-  const result = await fetch(environments[APPLE_IAP_ENVIRONMENT], {
-    body: JSON.stringify(payload),
-    method: 'POST',
-    // eslint-disable-next-line
-    // @ts-ignore
-    duplex: 'half',
-    headers: {
-      'Content-Type': 'application/json',
-    },
-  });
-  return result.json();
-};
-
-const AppleNotificationTypes = {
-  INITIAL_BUY: 'INITIAL_BUY',
-  DID_RECOVER: 'DID_RECOVER',
-  DID_CHANGE_RENEWAL_STATUS: 'DID_CHANGE_RENEWAL_STATUS',
-  DID_FAIL_TO_RENEW: 'DID_FAIL_TO_RENEW',
-  DID_CHANGE_RENEWAL_PREF: 'DID_CHANGE_RENEWAL_PREF',
-};
-
-const fixPeriods = async (
-  { transactionId, enrollmentId, orderId, transactions },
-  unchainedAPI: UnchainedCore,
-) => {
-  const relevantTransactions = transactions.filter(
-    // eslint-disable-next-line
-    ({ original_transaction_id }) => {
-      return original_transaction_id === transactionId; // eslint-disable-line
-    },
-  );
-
-  const adjustedEnrollmentPeriods = relevantTransactions
-    .map((transaction) => {
-      return {
-        isTrial: transaction.is_trial_period === 'true', // eslint-disable-line
-        start: new Date(parseInt(transaction.purchase_date_ms, 10)),
-        end: new Date(parseInt(transaction.expires_date_ms, 10)),
-        orderId: transaction.transaction_id === transactionId ? orderId : null,
-      };
-    })
-    .toSorted((left, right) => {
-      return left.end.getTime() - right.end.getTime();
-    });
-
-  await unchainedAPI.modules.enrollments.removeEnrollmentPeriodByOrderId(enrollmentId, orderId);
-
-  return Promise.all(
-    adjustedEnrollmentPeriods.map((period) =>
-      unchainedAPI.modules.enrollments.addEnrollmentPeriod(enrollmentId, period),
-    ),
-  );
-};
-
-export const appleIAPHandler = async (req, res) => {
-  if (req.method === 'POST') {
-    try {
-      const resolvedContext = req.unchainedContext as Context;
-      const { modules, services } = resolvedContext;
-      const responseBody = req.body || {};
-      if (responseBody.password !== APPLE_IAP_SHARED_SECRET) {
-        throw new Error('shared secret not valid');
-      }
-
-      const transactions = responseBody?.unified_receipt?.latest_receipt_info; // eslint-disable-line
-      const latestTransaction = transactions[0];
-
-      if (responseBody.notification_type === AppleNotificationTypes.INITIAL_BUY) {
-        // Find the cart to checkout
-        const orderPayment = await modules.orders.payments.findOrderPaymentByContextData({
-          context: {
-            'meta.transactionIdentifier': latestTransaction.transaction_id,
-          },
-        });
-
-        if (!orderPayment) throw new Error('Could not find any matching order payment');
-
-        const order = await services.orders.checkoutOrder(orderPayment.orderId, {
-          paymentContext: {
-                receiptData: responseBody?.unified_receipt?.latest_receipt, // eslint-disable-line
-          },
-        });
-        const orderId = order._id;
-        const enrollment = await modules.enrollments.findEnrollment({
-          orderId,
-        });
-        await fixPeriods(
-          {
-            transactionId: latestTransaction.original_transaction_id,
-            transactions,
-            enrollmentId: enrollment._id,
-            orderId,
-          },
-          resolvedContext,
-        );
-
-        logger.info(`Apple IAP Webhook: Confirmed checkout for order ${order.orderNumber}`, {
-          orderId: order._id,
-        });
-      } else {
-        // Just store payment credentials, use the enrollments paymentProvider reference and
-        // let the job do the rest
-        const originalOrderPayment = await modules.orders.payments.findOrderPaymentByContextData({
-          context: {
-            'meta.transactionIdentifier': latestTransaction.original_transaction_id,
-          },
-        });
-        if (!originalOrderPayment) throw new Error('Could not find any matching order payment');
-        const originalOrder = await modules.orders.findOrder({
-          orderId: originalOrderPayment.orderId,
-        });
-        const enrollment = await modules.enrollments.findEnrollment({
-          orderId: originalOrder._id,
-        });
-
-        await services.orders.registerPaymentCredentials(enrollment.payment.paymentProviderId, {
-          transactionContext: {
-              receiptData: responseBody?.unified_receipt?.latest_receipt, // eslint-disable-line
-          },
-          userId: enrollment.userId,
-        });
-
-        await fixPeriods(
-          {
-            transactionId: latestTransaction.original_transaction_id,
-            transactions,
-            enrollmentId: enrollment._id,
-            orderId: originalOrder._id,
-          },
-          resolvedContext,
-        );
-
-        logger.info(
-          `Apple IAP Webhook: Processed notification for ${latestTransaction.original_transaction_id} and type ${responseBody.notification_type}`,
-        );
-
-        if (responseBody.notification_type === AppleNotificationTypes.DID_RECOVER) {
-          if (
-            enrollment.status !== EnrollmentStatus.TERMINATED &&
-            responseBody.auto_renew_status === 'false'
-          ) {
-            await services.enrollments.terminateEnrollment(enrollment);
-          }
-        }
-
-        if (responseBody.notification_type === AppleNotificationTypes.DID_CHANGE_RENEWAL_STATUS) {
-          if (
-            enrollment.status !== EnrollmentStatus.TERMINATED &&
-            responseBody.auto_renew_status === 'false'
-          ) {
-            await services.enrollments.terminateEnrollment(enrollment);
-          }
-        }
-        logger.info(`Apple IAP Webhook: Updated enrollment from Apple`);
-      }
-
-      res.writeHead(200);
-      res.end();
-      return;
-    } catch (e) {
-      logger.warn(`Apple IAP Webhook: ${e.message}`, e);
-      res.writeHead(503);
-      res.end(JSON.stringify({ name: e.name, code: e.code, message: e.message }));
-      return;
-    }
-  }
-  res.writeHead(404);
-  res.end();
-};
+const { APPLE_IAP_SHARED_SECRET } = process.env;
 
 const AppleIAP: IPaymentAdapter = {
   ...PaymentAdapter,
@@ -205,7 +20,7 @@ const AppleIAP: IPaymentAdapter = {
   },
 
   actions: (params, context) => {
-    const { modules } = context;
+    const { order, modules } = context as typeof context & { modules: AppleTransactionsModule };
 
     const adapterActions = {
       ...PaymentAdapter.actions(params, context),
@@ -266,10 +81,8 @@ const AppleIAP: IPaymentAdapter = {
 
       // eslint-disable-next-line
       async charge(transactionContext) {
-        const { order } = context;
         const { meta, paymentCredentials, receiptData } = transactionContext || {};
         const { transactionIdentifier } = meta || {};
-        const appleTransactions = (context.modules as any).appleTransactions as AppleTransactionsModule;
 
         if (!transactionIdentifier) {
           throw new Error('Apple IAP Plugin: You have to set the transaction id on the order payment');
@@ -324,13 +137,13 @@ const AppleIAP: IPaymentAdapter = {
           throw new Error('Apple IAP Plugin: Product in order does not match transaction');
 
         const alreadyProcessedTransaction =
-          await appleTransactions.findTransactionById(transactionIdentifier);
+          await modules.appleTransactions.findTransactionById(transactionIdentifier);
 
         if (alreadyProcessedTransaction)
           throw new Error('Apple IAP Plugin: Transaction already processed');
 
         // All good
-        await appleTransactions.createTransaction({
+        await modules.appleTransactions.createTransaction({
           _id: transactionIdentifier,
           matchedTransaction,
           orderId: order._id,

package/src/payment/apple-iap/fix-periods.ts

@@ -0,0 +1,34 @@
+import { UnchainedCore } from '@unchainedshop/core';
+
+export const fixPeriods = async (
+  { transactionId, enrollmentId, orderId, transactions },
+  unchainedAPI: UnchainedCore,
+) => {
+  const relevantTransactions = transactions.filter(
+    // eslint-disable-next-line
+    ({ original_transaction_id }) => {
+      return original_transaction_id === transactionId; // eslint-disable-line
+    },
+  );
+
+  const adjustedEnrollmentPeriods = relevantTransactions
+    .map((transaction) => {
+      return {
+        isTrial: transaction.is_trial_period === 'true', // eslint-disable-line
+        start: new Date(parseInt(transaction.purchase_date_ms, 10)),
+        end: new Date(parseInt(transaction.expires_date_ms, 10)),
+        orderId: transaction.transaction_id === transactionId ? orderId : null,
+      };
+    })
+    .toSorted((left, right) => {
+      return left.end.getTime() - right.end.getTime();
+    });
+
+  await unchainedAPI.modules.enrollments.removeEnrollmentPeriodByOrderId(enrollmentId, orderId);
+
+  return Promise.all(
+    adjustedEnrollmentPeriods.map((period) =>
+      unchainedAPI.modules.enrollments.addEnrollmentPeriod(enrollmentId, period),
+    ),
+  );
+};