@nestjs-dash/media 0.1.1 → 1.0.1

package/README.md

@@ -0,0 +1,66 @@
+# @nestjs-dash/media
+
+A polymorphic media library plugin for nestjs-dash — Spatie-`laravel-medialibrary`-style media collections (attach many files to any model, grouped into named collections like `avatar` or `gallery`) built on top of [`@nestjs-dash/storage`](https://github.com/nestjs-dash/nestjs-dash)'s disks.
+
+## When you need this
+
+Only if you turn on `media.enabled` — most apps can use `@nestjs-dash/storage`'s upload fields directly without this plugin. Reach for `@nestjs-dash/media` when a record needs *multiple* attached files organized into named collections, rather than a single upload field per column.
+
+## Install
+
+```bash
+pnpm add @nestjs-dash/media
+```
+
+Requires `@nestjs-dash/storage` to be configured (this package stores files through it) and `typeorm` (media records persist to a TypeORM table).
+
+## Usage
+
+```ts
+import { AdminModule } from '@nestjs-dash/nestjs';
+
+AdminModule.forRootAsync({
+  useFactory: () => ({
+    panel: {
+      // ...
+      media: { enabled: true },
+    },
+  }),
+});
+```
+
+```ts
+import { MediaService } from '@nestjs-dash/media';
+import { StorageService } from '@nestjs-dash/storage';
+
+@Injectable()
+class ProductPhotosService {
+  constructor(
+    private readonly media: MediaService,
+    private readonly storage: StorageService,
+  ) {}
+
+  async attachPhoto(product: ProductEntity, file: Express.Multer.File) {
+    const stored = await this.storage.put(file.buffer, {
+      directory: 'gallery',
+      fileName: file.originalname,
+      contentType: file.mimetype,
+    });
+    await this.media.addFromUpload(
+      { modelType: 'Product', modelId: product.id },
+      'gallery',
+      { path: stored.path, disk: stored.disk, fileName: file.originalname, mimeType: file.mimetype, size: stored.size },
+    );
+  }
+}
+```
+
+`MediaEntity` is the underlying TypeORM entity (polymorphic `modelType`/`modelId` + `collectionName` + the underlying storage disk/key) — list it in your `TypeOrmModule.forRootAsync`'s `entities: [...]` array the same way you would any other entity `@nestjs-dash/*` provides.
+
+## Part of nestjs-dash
+
+This package is one piece of [nestjs-dash](https://github.com/nestjs-dash/nestjs-dash), a NestJS-native admin framework.
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs-dash/media",
-  "version": "0.1.1",
+  "version": "1.0.1",
   "description": "Polymorphic media library plugin for NestJS Dash (Spatie-style media collections on top of @nestjs-dash/storage)",
   "license": "MIT",
   "files": [
@@ -17,8 +17,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@nestjs-dash/nestjs": "0.1.1",
-    "@nestjs-dash/storage": "0.1.1"
+    "@nestjs-dash/nestjs": "1.0.1",
+    "@nestjs-dash/storage": "1.0.1"
   },
   "devDependencies": {
     "@nestjs-dash/typescript-config": "0.1.0",