@yayoyunlm/utils_sql_storage 1.0.0 → 1.2.0

package/README.md

@@ -1,15 +1,93 @@
-createDbClient(
-  PrismaClientConstructor: typeof PrismaClient, // 外部传入的 Prisma 构造函数
-  connectionString: string // PostgreSQL 连接字符串
-): PrismaClient // 返回配置好的 Prisma 客户端实例
+# @yayoyunlm/utils_sql_storage 简易使用手册
+这个工具包只有 **2个核心功能**：
+1. 快速连接 PostgreSQL 数据库
+2. 上传文件到 T3/S3 云存储
+**Monorepo 直接用，不用打包编译！**
 
+---
 
-// 1. 获取数据库连接字符串（环境变量）
-const DATABASE_URL = process.env.DATABASE_URL!;
-PrismaClient=schema.prismaoutput
+## 一、数据库工具（createDbClient）
+### 作用
+帮你快速创建 Prisma + PostgreSQL 数据库连接，不用写重复代码。
 
-// 2. 传入 PrismaClient + 连接串，创建实例
-const db = createDbClient(PrismaClient, DATABASE_URL);
+### 使用步骤
+1. 项目安装依赖
+```bash
+pnpm add @prisma/client pg @prisma/adapter-pg
+```
 
-// 3. 导出供全局使用
-export default db;
+2. 直接复制代码使用
+```ts
+// 引入工具和类型
+import { createDbClient } from '@yayoyunlm/utils_sql_storage';
+import { PrismaClient } from '@prisma/client';
+
+// 创建数据库客户端（替换成你的数据库链接）
+const db = createDbClient(PrismaClient, "postgresql://你的数据库连接字符串");
+
+// 使用示例（接口/服务中直接用）
+async function getList() {
+  return await db.表名.findMany();
+}
+```
+
+---
+
+## 二、文件上传工具（S3Uploader）
+### 作用
+上传文件到 T3 Storage / AWS S3，**适配 Next.js 接口**，region 默认自动配置，不用管。
+
+### 1. 安装依赖
+```bash
+pnpm add @aws-sdk/client-s3
+```
+
+### 2. 完整使用示例（Next.js 上传接口）
+直接复制就能用，改下密钥即可：
+```ts
+import { NextRequest, NextResponse } from 'next/server';
+import { S3Uploader } from '@yayoyunlm/utils_sql_storage';
+
+// 配置你的存储信息
+const s3Config = {
+  endpoint: '',
+  bucket: '',
+  accessKeyId: '你的密钥ID',
+  secretAccessKey: '你的密钥',
+};
+
+// 上传接口
+export async function POST(req: NextRequest) {
+  try {
+    const formData = await req.formData();
+    const file = formData.get('file') as File;
+
+    if (!file) {
+      return NextResponse.json({ error: '请选择文件' }, { status: 400 });
+    }
+
+    // 创建上传实例
+    const uploader = new S3Uploader(s3Config);
+    const buffer = Buffer.from(await file.arrayBuffer());
+    
+    // 执行上传
+    const result = await uploader.upload(buffer, file.name, file.type);
+
+    return NextResponse.json(result);
+  } catch (error) {
+    return NextResponse.json({ error: '上传失败' }, { status: 500 });
+  }
+}
+```
+
+### 3. 重要默认配置（不用改）
+`region` 自动默认为 `auto`，适配 T3 Storage，**不需要手动填写**。
+
+---
+
+## 三、使用小提示
+1. **Monorepo 专属**：修改工具包源码后，**重启 Next.js 服务** 就生效，不用执行 `build`
+2. 报错排查：
+   - 配置缺失：检查 endpoint、bucket、密钥是否正确
+   - 上传失败：检查云存储权限/密钥
+3. 所有代码复制粘贴即可使用，无需额外配置

package/dist/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,11 +17,20 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // index.ts
 var index_exports = {};
 __export(index_exports, {
+  S3Uploader: () => S3Uploader,
   createDbClient: () => createDbClient
 });
 module.exports = __toCommonJS(index_exports);
@@ -32,7 +43,95 @@ function createDbClient(PrismaClientConstructor, connectionString) {
   const adapter = new import_adapter_pg.PrismaPg(pool);
   return new PrismaClientConstructor({ adapter });
 }
+
+// linkstorage.ts
+var import_fs = __toESM(require("fs"), 1);
+var import_client_s3 = require("@aws-sdk/client-s3");
+var S3Uploader = class _S3Uploader {
+  // 1. 静态属性：初始化为 undefined，支持“不传”
+  static endpoint = void 0;
+  static bucket = void 0;
+  static region = void 0;
+  static accessKeyId = void 0;
+  static secretAccessKey = void 0;
+  // 2. 实例属性：定义为 string，确保实例化后一定是字符串（哪怕是空的）
+  bucket;
+  endpoint;
+  region;
+  s3Client;
+  constructor(config) {
+    this.endpoint = config?.endpoint ?? _S3Uploader.endpoint ?? "";
+    this.bucket = config?.bucket ?? _S3Uploader.bucket ?? "";
+    this.region = config?.region ?? _S3Uploader.region ?? "auto";
+    const accessKeyId = config?.accessKeyId ?? _S3Uploader.accessKeyId ?? "";
+    const secretAccessKey = config?.secretAccessKey ?? _S3Uploader.secretAccessKey ?? "";
+    if (!this.endpoint || !this.bucket || !accessKeyId || !secretAccessKey) {
+      throw new Error(
+        "S3\u914D\u7F6E\u7F3A\u5931\uFF1A\u8BF7\u786E\u4FDD\u8BBE\u7F6E\u4E86\u9759\u6001\u5C5E\u6027\uFF0C\u6216\u5728 new \u65F6\u4F20\u5165\u5B8C\u6574\u914D\u7F6E"
+      );
+    }
+    this.s3Client = new import_client_s3.S3Client({
+      endpoint: this.endpoint,
+      region: this.region,
+      // AWS SDK 支持 region 为空字符串或 undefined
+      credentials: {
+        accessKeyId,
+        secretAccessKey
+      },
+      forcePathStyle: true
+    });
+  }
+  // 5. 核心修复：支持 Buffer | string
+  // 这样既支持本地路径，也支持 Next.js 的 file.arrayBuffer()
+  async upload(fileContent, s3Path, contentType = "application/octet-stream") {
+    try {
+      const normalizedKey = s3Path.replace(/^\//, "");
+      const body = typeof fileContent === "string" ? import_fs.default.createReadStream(fileContent) : fileContent;
+      const command = new import_client_s3.PutObjectCommand({
+        Bucket: this.bucket,
+        Key: normalizedKey,
+        Body: body,
+        ContentType: contentType
+      });
+      await this.s3Client.send(command);
+      const baseUrl = this.endpoint.endsWith("/") ? this.endpoint.slice(0, -1) : this.endpoint;
+      const url = `${baseUrl}/${this.bucket}/${normalizedKey}`;
+      return {
+        success: true,
+        url,
+        s3Path: normalizedKey
+      };
+    } catch (err) {
+      console.error("\u4E0A\u4F20\u5931\u8D25", err);
+      return {
+        success: false,
+        error: err instanceof Error ? err.message : "\u672A\u77E5\u9519\u8BEF"
+      };
+    }
+  }
+  async delete(s3Path) {
+    try {
+      const normalizedKey = s3Path.replace(/^\//, "");
+      const command = new import_client_s3.DeleteObjectCommand({
+        Bucket: this.bucket,
+        Key: normalizedKey
+      });
+      await this.s3Client.send(command);
+      return {
+        success: true,
+        s3Path: normalizedKey
+      };
+    } catch (err) {
+      console.error("\u5220\u9664\u5931\u8D25", err);
+      return {
+        success: false,
+        error: err instanceof Error ? err.message : "\u672A\u77E5\u9519\u8BEF"
+      };
+    }
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  S3Uploader,
   createDbClient
 });

package/dist/index.d.cts

@@ -13,4 +13,38 @@ declare function createDbClient(PrismaClientConstructor: typeof PrismaClient, co
     adapter: PrismaPg;
 }, never, _prisma_client_runtime_client.DefaultArgs>;
 
-export { createDbClient };
+interface S3UploaderConfig {
+    endpoint?: string;
+    bucket?: string;
+    region?: string;
+    accessKeyId?: string;
+    secretAccessKey?: string;
+}
+interface UploadResult {
+    success: boolean;
+    url?: string;
+    s3Path?: string;
+    error?: string;
+}
+interface DeleteResult {
+    success: boolean;
+    s3Path?: string;
+    error?: string;
+}
+declare class S3Uploader {
+    static endpoint: string | undefined;
+    static bucket: string | undefined;
+    static region: string | undefined;
+    static accessKeyId: string | undefined;
+    static secretAccessKey: string | undefined;
+    private readonly bucket;
+    private readonly endpoint;
+    private readonly region;
+    private readonly s3Client;
+    constructor(config?: S3UploaderConfig);
+    upload(fileContent: string | Buffer, // 接收文件路径 或 文件二进制流
+    s3Path: string, contentType?: string): Promise<UploadResult>;
+    delete(s3Path: string): Promise<DeleteResult>;
+}
+
+export { type DeleteResult, S3Uploader, type S3UploaderConfig, type UploadResult, createDbClient };

package/dist/index.d.ts

@@ -13,4 +13,38 @@ declare function createDbClient(PrismaClientConstructor: typeof PrismaClient, co
     adapter: PrismaPg;
 }, never, _prisma_client_runtime_client.DefaultArgs>;
 
-export { createDbClient };
+interface S3UploaderConfig {
+    endpoint?: string;
+    bucket?: string;
+    region?: string;
+    accessKeyId?: string;
+    secretAccessKey?: string;
+}
+interface UploadResult {
+    success: boolean;
+    url?: string;
+    s3Path?: string;
+    error?: string;
+}
+interface DeleteResult {
+    success: boolean;
+    s3Path?: string;
+    error?: string;
+}
+declare class S3Uploader {
+    static endpoint: string | undefined;
+    static bucket: string | undefined;
+    static region: string | undefined;
+    static accessKeyId: string | undefined;
+    static secretAccessKey: string | undefined;
+    private readonly bucket;
+    private readonly endpoint;
+    private readonly region;
+    private readonly s3Client;
+    constructor(config?: S3UploaderConfig);
+    upload(fileContent: string | Buffer, // 接收文件路径 或 文件二进制流
+    s3Path: string, contentType?: string): Promise<UploadResult>;
+    delete(s3Path: string): Promise<DeleteResult>;
+}
+
+export { type DeleteResult, S3Uploader, type S3UploaderConfig, type UploadResult, createDbClient };

package/dist/index.js

@@ -6,6 +6,94 @@ function createDbClient(PrismaClientConstructor, connectionString) {
   const adapter = new PrismaPg(pool);
   return new PrismaClientConstructor({ adapter });
 }
+
+// linkstorage.ts
+import fs from "fs";
+import { S3Client, PutObjectCommand, DeleteObjectCommand } from "@aws-sdk/client-s3";
+var S3Uploader = class _S3Uploader {
+  // 1. 静态属性：初始化为 undefined，支持“不传”
+  static endpoint = void 0;
+  static bucket = void 0;
+  static region = void 0;
+  static accessKeyId = void 0;
+  static secretAccessKey = void 0;
+  // 2. 实例属性：定义为 string，确保实例化后一定是字符串（哪怕是空的）
+  bucket;
+  endpoint;
+  region;
+  s3Client;
+  constructor(config) {
+    this.endpoint = config?.endpoint ?? _S3Uploader.endpoint ?? "";
+    this.bucket = config?.bucket ?? _S3Uploader.bucket ?? "";
+    this.region = config?.region ?? _S3Uploader.region ?? "auto";
+    const accessKeyId = config?.accessKeyId ?? _S3Uploader.accessKeyId ?? "";
+    const secretAccessKey = config?.secretAccessKey ?? _S3Uploader.secretAccessKey ?? "";
+    if (!this.endpoint || !this.bucket || !accessKeyId || !secretAccessKey) {
+      throw new Error(
+        "S3\u914D\u7F6E\u7F3A\u5931\uFF1A\u8BF7\u786E\u4FDD\u8BBE\u7F6E\u4E86\u9759\u6001\u5C5E\u6027\uFF0C\u6216\u5728 new \u65F6\u4F20\u5165\u5B8C\u6574\u914D\u7F6E"
+      );
+    }
+    this.s3Client = new S3Client({
+      endpoint: this.endpoint,
+      region: this.region,
+      // AWS SDK 支持 region 为空字符串或 undefined
+      credentials: {
+        accessKeyId,
+        secretAccessKey
+      },
+      forcePathStyle: true
+    });
+  }
+  // 5. 核心修复：支持 Buffer | string
+  // 这样既支持本地路径，也支持 Next.js 的 file.arrayBuffer()
+  async upload(fileContent, s3Path, contentType = "application/octet-stream") {
+    try {
+      const normalizedKey = s3Path.replace(/^\//, "");
+      const body = typeof fileContent === "string" ? fs.createReadStream(fileContent) : fileContent;
+      const command = new PutObjectCommand({
+        Bucket: this.bucket,
+        Key: normalizedKey,
+        Body: body,
+        ContentType: contentType
+      });
+      await this.s3Client.send(command);
+      const baseUrl = this.endpoint.endsWith("/") ? this.endpoint.slice(0, -1) : this.endpoint;
+      const url = `${baseUrl}/${this.bucket}/${normalizedKey}`;
+      return {
+        success: true,
+        url,
+        s3Path: normalizedKey
+      };
+    } catch (err) {
+      console.error("\u4E0A\u4F20\u5931\u8D25", err);
+      return {
+        success: false,
+        error: err instanceof Error ? err.message : "\u672A\u77E5\u9519\u8BEF"
+      };
+    }
+  }
+  async delete(s3Path) {
+    try {
+      const normalizedKey = s3Path.replace(/^\//, "");
+      const command = new DeleteObjectCommand({
+        Bucket: this.bucket,
+        Key: normalizedKey
+      });
+      await this.s3Client.send(command);
+      return {
+        success: true,
+        s3Path: normalizedKey
+      };
+    } catch (err) {
+      console.error("\u5220\u9664\u5931\u8D25", err);
+      return {
+        success: false,
+        error: err instanceof Error ? err.message : "\u672A\u77E5\u9519\u8BEF"
+      };
+    }
+  }
+};
 export {
+  S3Uploader,
   createDbClient
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yayoyunlm/utils_sql_storage",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "TypeScript library build with tsup",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -18,13 +18,15 @@
     "typescript": "^5",
     "@types/pg": "^8.11.0",
     "@prisma/client": "^7.8.0",
-    "@prisma/adapter-pg": "^7.8.0"
+    "@prisma/adapter-pg": "^7.8.0",
+    "@aws-sdk/client-s3": "^3.1048.0"
   },
   "peerDependencies": {
     "pg": "^8.20.0",
     "prisma": "^7.8.0",
     "@prisma/client": "^7.8.0",
-    "@prisma/adapter-pg": "^7.8.0"
+    "@prisma/adapter-pg": "^7.8.0",
+    "@aws-sdk/client-s3": "^3.1048.0"
   },
   "scripts": {
     "build": "tsup index.ts --format cjs,esm --dts"