@veloxts/storage 0.6.57 → 0.6.59

package/README.md

@@ -1,30 +1,8 @@
 # @veloxts/storage
 
-> **Early Preview** - APIs may change before v1.0.
+> **Early Preview (v0.6.x)** - APIs are stabilizing but may still change. Use with caution in production.
 
-File storage abstraction with local filesystem and S3-compatible drivers.
-
-## Installation
-
-```bash
-npm install @veloxts/storage
-```
-
-## Quick Start
-
-```typescript
-import { storagePlugin } from '@veloxts/storage';
-
-app.use(storagePlugin({ driver: 'local', root: './storage' }));
-
-// Upload a file
-await ctx.storage.put('avatars/user-123.jpg', buffer, { visibility: 'public' });
-
-// Get public URL
-const url = await ctx.storage.url('avatars/user-123.jpg');
-```
-
-See [GUIDE.md](./GUIDE.md) for detailed documentation.
+File storage abstraction for VeloxTS Framework - provides local filesystem and S3-compatible drivers with streaming and signed URLs. Learn more at [@veloxts/velox](https://www.npmjs.com/package/@veloxts/velox).
 
 ## License
 

package/dist/index.d.ts

@@ -43,6 +43,20 @@ export { FileExistsError, FileNotFoundError, InvalidPathError, isFileNotFoundErr
 export { createStorageManager, type StorageManager, storage } from './manager.js';
 export { _resetStandaloneStorage, getStorage, getStorageFromInstance, storagePlugin, } from './plugin.js';
 export type { CopyOptions, FileMetadata, FileVisibility, GetOptions, ListOptions, ListResult, LocalStorageConfig, PutOptions, S3StorageConfig, SignedUrlOptions, StorageBaseOptions, StorageConfig, StorageDefaultOptions, StorageDriver, StorageLocalOptions, StorageManagerOptions, StoragePluginOptions, StorageS3Options, StorageStore, } from './types.js';
+/**
+ * Utility functions for storage operations.
+ *
+ * @deprecated Import from '@veloxts/storage/utils' instead. Will be removed in v2.0.
+ *
+ * @example
+ * ```typescript
+ * // Old (deprecated):
+ * import { formatBytes, detectMimeType } from '@veloxts/storage';
+ *
+ * // New:
+ * import { formatBytes, detectMimeType } from '@veloxts/storage/utils';
+ * ```
+ */
 export { basename, detectMimeType, dirname, extname, formatBytes, joinPath, normalizePath, uniqueFileName, validatePath, } from './utils.js';
 /**
  * DI tokens and providers for @veloxts/storage

package/dist/index.js

@@ -46,7 +46,20 @@ export { FileExistsError, FileNotFoundError, InvalidPathError, isFileNotFoundErr
 export { createStorageManager, storage } from './manager.js';
 // Plugin
 export { _resetStandaloneStorage, getStorage, getStorageFromInstance, storagePlugin, } from './plugin.js';
-// Utilities
+/**
+ * Utility functions for storage operations.
+ *
+ * @deprecated Import from '@veloxts/storage/utils' instead. Will be removed in v2.0.
+ *
+ * @example
+ * ```typescript
+ * // Old (deprecated):
+ * import { formatBytes, detectMimeType } from '@veloxts/storage';
+ *
+ * // New:
+ * import { formatBytes, detectMimeType } from '@veloxts/storage/utils';
+ * ```
+ */
 export { basename, detectMimeType, dirname, extname, formatBytes, joinPath, normalizePath, uniqueFileName, validatePath, } from './utils.js';
 // ============================================================================
 // Dependency Injection

package/dist/manager.d.ts

@@ -224,6 +224,33 @@ export interface StorageManager {
      * @returns Current visibility, or null if not determinable
      */
     getVisibility(path: string): Promise<FileVisibility | null>;
+    /**
+     * Make a file publicly accessible.
+     * Convenience method that calls setVisibility(path, 'public').
+     *
+     * @param path - File path/key
+     *
+     * @example
+     * ```typescript
+     * await storage.makePublic('uploads/avatar.jpg');
+     * const url = await storage.url('uploads/avatar.jpg');
+     * ```
+     */
+    makePublic(path: string): Promise<void>;
+    /**
+     * Make a file private (not publicly accessible).
+     * Convenience method that calls setVisibility(path, 'private').
+     *
+     * @param path - File path/key
+     *
+     * @example
+     * ```typescript
+     * await storage.makePrivate('documents/sensitive.pdf');
+     * // Use signedUrl() for temporary access
+     * const signedUrl = await storage.signedUrl('documents/sensitive.pdf');
+     * ```
+     */
+    makePrivate(path: string): Promise<void>;
     /**
      * Close/cleanup the storage connection.
      */

package/dist/manager.js

@@ -99,6 +99,8 @@ export async function createStorageManager(options = {}) {
         signedUrl: (path, signedOptions) => store.signedUrl(path, signedOptions),
         setVisibility: (path, visibility) => store.setVisibility(path, visibility),
         getVisibility: (path) => store.getVisibility(path),
+        makePublic: (path) => store.setVisibility(path, 'public'),
+        makePrivate: (path) => store.setVisibility(path, 'private'),
         close: () => store.close(),
     };
     return manager;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veloxts/storage",
-  "version": "0.6.57",
+  "version": "0.6.59",
   "description": "Multi-driver file storage abstraction for VeloxTS framework",
   "type": "module",
   "main": "./dist/index.js",
@@ -11,6 +11,10 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     },
+    "./utils": {
+      "types": "./dist/utils.d.ts",
+      "import": "./dist/utils.js"
+    },
     "./drivers/local": {
       "types": "./dist/drivers/local.d.ts",
       "import": "./dist/drivers/local.js"
@@ -28,7 +32,7 @@
   "dependencies": {
     "fastify-plugin": "5.1.0",
     "mime-types": "2.1.35",
-    "@veloxts/core": "0.6.57"
+    "@veloxts/core": "0.6.59"
   },
   "peerDependencies": {
     "@aws-sdk/client-s3": ">=3.0.0",
@@ -57,7 +61,7 @@
     "fastify": "5.6.2",
     "typescript": "5.8.3",
     "vitest": "4.0.16",
-    "@veloxts/testing": "0.6.57"
+    "@veloxts/testing": "0.6.59"
   },
   "publishConfig": {
     "access": "public"