@superfunctions/storage-s3 0.1.0

package/dist/adapter.d.ts

@@ -0,0 +1,10 @@
+import type { StorageAdapter } from '@superfunctions/storage';
+export interface S3StorageConfig {
+    bucket: string;
+    region: string;
+    accessKeyId?: string;
+    secretAccessKey?: string;
+    endpoint?: string;
+    forcePathStyle?: boolean;
+}
+export declare function createS3StorageAdapter(config: S3StorageConfig): StorageAdapter;

package/dist/adapter.js

@@ -0,0 +1,30 @@
+import { S3Client } from '@aws-sdk/client-s3';
+import { createS3CompatibleStorageAdapter } from '@superfunctions/storage/internal/s3-compatible';
+export function createS3StorageAdapter(config) {
+    const { bucket, region, accessKeyId, secretAccessKey, endpoint, forcePathStyle } = config;
+    const hasAccessKeyId = accessKeyId !== undefined;
+    const hasSecretAccessKey = secretAccessKey !== undefined;
+    let credentials;
+    if (hasAccessKeyId !== hasSecretAccessKey) {
+        throw new Error('S3 storage config requires both accessKeyId and secretAccessKey when using static credentials');
+    }
+    if (hasAccessKeyId && hasSecretAccessKey) {
+        if (accessKeyId === '' || secretAccessKey === '') {
+            throw new Error('S3 storage config requires non-empty accessKeyId and secretAccessKey when using static credentials');
+        }
+        credentials = { accessKeyId, secretAccessKey };
+    }
+    const client = new S3Client({
+        region,
+        endpoint,
+        forcePathStyle,
+        credentials,
+    });
+    return createS3CompatibleStorageAdapter({
+        name: 's3',
+        bucket,
+        client,
+        statNotFoundErrorNames: ['NotFound'],
+        downloadNotFoundErrorNames: ['NoSuchKey'],
+    });
+}

package/dist/adapter.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/adapter.test.js

@@ -0,0 +1,98 @@
+import { describe, it, expect } from 'vitest';
+import { createS3StorageAdapter } from './adapter.js';
+import { runConformanceTests } from '@superfunctions/storage';
+describe('storage-s3 adapter', () => {
+    describe('conformance', () => {
+        it('should pass conformance tests (method existence)', async () => {
+            const adapter = createS3StorageAdapter({
+                bucket: 'test-bucket',
+                region: 'us-east-1',
+            });
+            const result = await runConformanceTests(adapter);
+            expect(result.ok).toBe(true);
+        });
+        it('should have correct capabilities', () => {
+            const adapter = createS3StorageAdapter({
+                bucket: 'test-bucket',
+                region: 'us-east-1',
+            });
+            expect(adapter.capabilities).toEqual({
+                signedUploadUrls: true,
+                signedDownloadUrls: true,
+                multipart: true,
+                proxyStreamingUpload: false,
+                proxyStreamingDownload: true,
+            });
+        });
+    });
+    describe('adapter creation', () => {
+        it('should create adapter with minimal config', () => {
+            const adapter = createS3StorageAdapter({
+                bucket: 'my-bucket',
+                region: 'eu-west-1',
+            });
+            expect(adapter.name).toBe('s3');
+        });
+        it('should create adapter with full config', () => {
+            const adapter = createS3StorageAdapter({
+                bucket: 'my-bucket',
+                region: 'us-east-1',
+                accessKeyId: 'AKIAIOSFODNN7EXAMPLE',
+                secretAccessKey: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
+                endpoint: 'http://localhost:9000',
+                forcePathStyle: true,
+            });
+            expect(adapter.name).toBe('s3');
+        });
+        it('requires both static credential fields when either is provided', () => {
+            expect(() => createS3StorageAdapter({
+                bucket: 'my-bucket',
+                region: 'us-east-1',
+                accessKeyId: 'AKIAIOSFODNN7EXAMPLE',
+            })).toThrow('S3 storage config requires both accessKeyId and secretAccessKey when using static credentials');
+        });
+        it('rejects empty static credentials instead of silently falling back', () => {
+            expect(() => createS3StorageAdapter({
+                bucket: 'my-bucket',
+                region: 'us-east-1',
+                accessKeyId: '',
+                secretAccessKey: '',
+            })).toThrow('S3 storage config requires non-empty accessKeyId and secretAccessKey when using static credentials');
+        });
+    });
+    describe('multipart methods', () => {
+        it('should have all multipart methods', () => {
+            const adapter = createS3StorageAdapter({
+                bucket: 'test-bucket',
+                region: 'us-east-1',
+            });
+            expect(adapter.createMultipartUpload).toBeDefined();
+            expect(adapter.signMultipartUploadPartUrl).toBeDefined();
+            expect(adapter.completeMultipartUpload).toBeDefined();
+            expect(adapter.abortMultipartUpload).toBeDefined();
+        });
+    });
+    describe('signed URL methods', () => {
+        it('should have signed URL methods', () => {
+            const adapter = createS3StorageAdapter({
+                bucket: 'test-bucket',
+                region: 'us-east-1',
+            });
+            expect(adapter.signUploadUrl).toBeDefined();
+            expect(adapter.signDownloadUrl).toBeDefined();
+        });
+    });
+    describe('completeMultipartUpload validation', () => {
+        it('should reject empty parts array', async () => {
+            const adapter = createS3StorageAdapter({
+                bucket: 'test-bucket',
+                region: 'us-east-1',
+            });
+            await expect(adapter.completeMultipartUpload({
+                key: 'test-key',
+                uploadId: 'test-upload-id',
+                parts: [],
+            })).rejects.toMatchObject({ code: 'STORAGE_MULTIPART_INVALID' });
+        });
+    });
+});

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { createS3StorageAdapter, createS3StorageAdapter as createS3Storage } from './adapter.js';
+export type { S3StorageConfig } from './adapter.js';

package/dist/index.js

@@ -0,0 +1 @@
+export { createS3StorageAdapter, createS3StorageAdapter as createS3Storage } from './adapter.js';

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@superfunctions/storage-s3",
+  "version": "0.1.0",
+  "description": "S3 storage adapter for @superfunctions/storage",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist"
+  },
+  "keywords": ["storage", "s3", "aws", "superfunctions"],
+  "author": "21n",
+  "license": "MIT",
+  "bugs": { "url": "https://github.com/21nCo/super-functions/issues" },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/21nCo/super-functions.git",
+    "directory": "packages/storage-s3"
+  },
+  "publishConfig": { "access": "public" },
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.600.0",
+    "@aws-sdk/s3-request-presigner": "^3.600.0",
+    "@superfunctions/storage": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "^5.6.0",
+    "vitest": "^3.2.4"
+  }
+}