@yimingliao/cms 0.0.18 → 0.0.19

package/dist/server/index.d.ts

@@ -4,6 +4,8 @@ import { cookies } from 'next/headers';
 import { S3Client } from '@aws-sdk/client-s3';
 import { Logger } from 'logry';
 import { i as BlobFile, e as AdminRole, w as SingleItem, B as BaseTranslation, a as Admin, c as AdminFull, f as AdminSafe, D as DeviceInfo, d as AdminRefreshToken, l as File, n as FileFull, p as FileType, q as Folder, F as FolderFull, v as PostType, M as MultiItems, E as ExternalLink, k as Faq, T as TocItem, r as Post, t as PostListCard, u as PostTranslation, s as PostFull, S as SeoMetadata, g as AdminTranslation, o as FileTranslation, h as Alternate } from '../types-Bhnz5Z1F.js';
+import { Pool } from 'generic-pool';
+import SFTPClient from 'ssh2-sftp-client';
 import Keyv from 'keyv';
 
 interface CreateJwtServiceOptions {
@@ -72,24 +74,39 @@ declare function createCookieService(nextCookies: () => Promise<Awaited<ReturnTy
     }) => Promise<void>;
 };
 
-interface CreateR2ServiceOptions {
-    r2Client: S3Client;
-    bucketName: string;
-    logger: Logger;
-}
-declare function createR2Service({ r2Client, bucketName, logger, }: CreateR2ServiceOptions): {
-    upload: ({ blobFile, folderKey, }: {
+interface StorageService {
+    upload(options: {
         blobFile: BlobFile;
         folderKey?: string;
-    }) => Promise<string>;
-    remove: ({ key }: {
+    }): Promise<string>;
+    remove(options: {
         key: string;
-    }) => Promise<void>;
-    move: ({ fromKey, toKey }: {
+    }): Promise<void>;
+    move(options: {
         fromKey: string;
         toKey: string;
-    }) => Promise<void>;
-};
+    }): Promise<void>;
+}
+
+interface CreateR2ServiceOptions {
+    r2Client: S3Client;
+    bucketName: string;
+    logger: Logger;
+}
+declare function createR2Service({ r2Client, bucketName, logger, }: CreateR2ServiceOptions): StorageService;
+
+interface CreateSftpServiceOptions {
+    sftpPool: Pool<SFTPClient>;
+    basePath: string;
+    logger: Logger;
+}
+declare function createSftpService({ sftpPool, basePath, logger, }: CreateSftpServiceOptions): StorageService;
+
+interface CreateSftpPoolOptions {
+    sftpClientOptions: SFTPClient.ConnectOptions;
+    logger: Logger;
+}
+declare const createSftpPool: ({ sftpClientOptions, logger, }: CreateSftpPoolOptions) => Pool<SFTPClient>;
 
 interface CreateServerCacheOptions {
     redisUrl: string;
@@ -616,4 +633,4 @@ declare const POST_ORDER_BY: ({
     index: "asc";
 })[];
 
-export { ADMIN_ORDER_BY, ORDER_BY, POST_ORDER_BY, type RawCacheKey, createAdminCommandRepository, createAdminQueryRepository, createAdminRefreshTokenCommandRepository, createAdminRefreshTokenQueryRepository, createArgon2Service, createCache, createCacheResult, createCookieService, createCryptoService, createFileCommandRepository, createFileQueryRepository, createFolderCommandRepository, createFolderQueryRepository, createIpRateLimiter, createJwtService, createPostCommandRepository, createPostQueryRepository, createR2Service, createSeoMetadataCommandRepository, normalizeCacheKey };
+export { ADMIN_ORDER_BY, ORDER_BY, POST_ORDER_BY, type RawCacheKey, createAdminCommandRepository, createAdminQueryRepository, createAdminRefreshTokenCommandRepository, createAdminRefreshTokenQueryRepository, createArgon2Service, createCache, createCacheResult, createCookieService, createCryptoService, createFileCommandRepository, createFileQueryRepository, createFolderCommandRepository, createFolderQueryRepository, createIpRateLimiter, createJwtService, createPostCommandRepository, createPostQueryRepository, createR2Service, createSeoMetadataCommandRepository, createSftpPool, createSftpService, normalizeCacheKey };

package/dist/server/index.js

@@ -4,8 +4,10 @@ import argon2 from 'argon2';
 import crypto, { timingSafeEqual } from 'crypto';
 import { headers } from 'next/headers';
 import { PutObjectCommand, DeleteObjectCommand, CopyObjectCommand } from '@aws-sdk/client-s3';
-import path from 'path/posix';
+import path2 from 'path/posix';
 import { ulid } from 'ulid';
+import { createPool } from 'generic-pool';
+import SFTPClient from 'ssh2-sftp-client';
 import KeyvRedis from '@keyv/redis';
 import Keyv from 'keyv';
 
@@ -205,17 +207,17 @@ function createObjectKey({
   mimeType,
   folderKey = ""
 }) {
-  const extensionFromFilename = path.extname(filename ?? "").toLowerCase();
+  const extensionFromFilename = path2.extname(filename ?? "").toLowerCase();
   const extensionFromMime = !extensionFromFilename && mimeType ? `.${mimeToExtension(mimeType)}` : "";
   const extension = extensionFromFilename || extensionFromMime;
   const normalizedFolder = folderKey.replace(/^\/+/, "").replace(/\/+$/, "");
   const id = ulid();
   const filenameWithId = id + extension;
   if (!normalizedFolder) return filenameWithId;
-  return path.join(normalizedFolder, filenameWithId);
+  return path2.join(normalizedFolder, filenameWithId);
 }
 
-// src/server/infrastructure/r2/r2.service.ts
+// src/server/infrastructure/storage/r2/r2.service.ts
 function createR2Service({
   r2Client,
   bucketName,
@@ -243,7 +245,7 @@ function createR2Service({
       logger.debug("R2 upload success", { key });
       return key;
     } catch (error) {
-      logger.error("upload failed", { key, error });
+      logger.error("R2 upload failed", { key, error });
       throw error;
     }
   }
@@ -257,7 +259,7 @@ function createR2Service({
       );
       logger.debug("R2 object removed", { key });
     } catch (error) {
-      logger.error("Remove failed", { key, error });
+      logger.error("R2 remove failed", { key, error });
       throw error;
     }
   }
@@ -277,7 +279,7 @@ function createR2Service({
       await remove({ key: fromKey });
       logger.debug("R2 object moved", { fromKey, toKey });
     } catch (error) {
-      logger.error("Move failed", { fromKey, toKey, error });
+      logger.error("R2 move failed", { fromKey, toKey, error });
       throw error;
     }
   }
@@ -287,6 +289,123 @@ function createR2Service({
     move
   };
 }
+function createSftpService({
+  sftpPool,
+  basePath,
+  logger
+}) {
+  async function upload({
+    blobFile,
+    folderKey = ""
+  }) {
+    const key = createObjectKey({
+      filename: blobFile.name,
+      mimeType: blobFile.type,
+      folderKey
+    });
+    const fullPath = path2.join(basePath, key);
+    const client = await sftpPool.acquire();
+    try {
+      const buffer = Buffer.from(await blobFile.arrayBuffer());
+      await client.put(buffer, fullPath);
+      logger.debug("SFTP upload success", { key });
+      return key;
+    } catch (error) {
+      logger.error("SFTP upload failed", { key, error });
+      throw error;
+    } finally {
+      await sftpPool.release(client);
+    }
+  }
+  async function remove({ key }) {
+    const fullPath = path2.join(basePath, key);
+    const client = await sftpPool.acquire();
+    try {
+      await client.delete(fullPath);
+      logger.debug("SFTP object removed", { key });
+    } catch (error) {
+      if (error instanceof Error && /no such file/i.test(error.message)) {
+        logger.debug("SFTP remove skipped (not found)", { key });
+        return;
+      }
+      logger.error("SFTP remove failed", { key, error });
+      throw error;
+    } finally {
+      await sftpPool.release(client);
+    }
+  }
+  async function move({ fromKey, toKey }) {
+    if (fromKey === toKey) {
+      logger.debug("SFTP move skipped (same key)", { key: fromKey });
+      return;
+    }
+    const fromPath = path2.join(basePath, fromKey);
+    const toPath = path2.join(basePath, toKey);
+    const client = await sftpPool.acquire();
+    try {
+      await client.rename(fromPath, toPath);
+      logger.debug("SFTP object moved", { fromKey, toKey });
+    } catch (error) {
+      logger.error("SFTP move failed", { fromKey, toKey, error });
+      throw error;
+    } finally {
+      await sftpPool.release(client);
+    }
+  }
+  return {
+    upload,
+    remove,
+    move
+  };
+}
+var createSftpPool = ({
+  sftpClientOptions,
+  logger
+}) => {
+  return createPool(
+    {
+      create: async () => {
+        const client = new SFTPClient();
+        try {
+          await client.connect({
+            readyTimeout: 2e4,
+            keepaliveInterval: 1e4,
+            keepaliveCountMax: 3,
+            ...sftpClientOptions
+          });
+          return client;
+        } catch (error) {
+          logger.error("SFTP connect failed", { error });
+          throw error;
+        }
+      },
+      validate: async (client) => {
+        try {
+          await client.realPath("/");
+          return true;
+        } catch {
+          logger.debug("SFTP session invalid, removing from pool");
+          return false;
+        }
+      },
+      destroy: async (client) => {
+        try {
+          await client.end();
+        } catch (error) {
+          logger.error("SFTP destroy failed", { error });
+        }
+      }
+    },
+    {
+      max: 3,
+      min: 0,
+      idleTimeoutMillis: 6e4,
+      acquireTimeoutMillis: 1e4,
+      evictionRunIntervalMillis: 3e4,
+      testOnBorrow: true
+    }
+  );
+};
 
 // src/server/infrastructure/cache/cache-key-delimiter.ts
 var CACHE_KEY_DELIMITER = "|";
@@ -1509,4 +1628,4 @@ function createSeoMetadataCommandRepository(prisma) {
   };
 }
 
-export { ADMIN_ORDER_BY, ORDER_BY, POST_ORDER_BY, createAdminCommandRepository, createAdminQueryRepository, createAdminRefreshTokenCommandRepository, createAdminRefreshTokenQueryRepository, createArgon2Service, createCache, createCacheResult, createCookieService, createCryptoService, createFileCommandRepository, createFileQueryRepository, createFolderCommandRepository, createFolderQueryRepository, createIpRateLimiter, createJwtService, createPostCommandRepository, createPostQueryRepository, createR2Service, createSeoMetadataCommandRepository, normalizeCacheKey };
+export { ADMIN_ORDER_BY, ORDER_BY, POST_ORDER_BY, createAdminCommandRepository, createAdminQueryRepository, createAdminRefreshTokenCommandRepository, createAdminRefreshTokenQueryRepository, createArgon2Service, createCache, createCacheResult, createCookieService, createCryptoService, createFileCommandRepository, createFileQueryRepository, createFolderCommandRepository, createFolderQueryRepository, createIpRateLimiter, createJwtService, createPostCommandRepository, createPostQueryRepository, createR2Service, createSeoMetadataCommandRepository, createSftpPool, createSftpService, normalizeCacheKey };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yimingliao/cms",
-  "version": "0.0.18",
+  "version": "0.0.19",
   "author": "Yiming Liao",
   "license": "MIT",
   "type": "module",
@@ -35,20 +35,31 @@
     "ulid": "^3.0.2"
   },
   "devDependencies": {
+    "@aws-sdk/client-s3": "^3.1004.0",
     "@prisma/client": "6.5.0",
     "@types/jsonwebtoken": "^9.0.10",
     "@types/mime-types": "^3.0.1",
+    "@types/ssh2-sftp-client": "^9.0.6",
+    "generic-pool": "^3.9.0",
     "next": "^16.1.6",
     "prisma": "6.5.0",
     "tsup": "^8.5.1",
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@aws-sdk/client-s3": "^3.0.0"
+    "@aws-sdk/client-s3": "^3.0.0",
+    "generic-pool": "^3.9.0",
+    "ssh2-sftp-client": "^12.1.0"
   },
   "peerDependenciesMeta": {
     "@aws-sdk/client-s3": {
       "optional": true
+    },
+    "generic-pool": {
+      "optional": true
+    },
+    "ssh2-sftp-client": {
+      "optional": true
     }
   }
 }