Merge branch 'develop'

Author: batosai

.github/workflows/npm-publish.yml

@@ -0,0 +1,71 @@
+name: NPM publish
+
+on:
+  push:
+    branches:
+      - 'main'
+
+env:
+  success: ✅
+  failure: 🔴
+  cancelled: ❌
+  skipped: ⭕
+  node_version: 20
+  true: ✅
+  false: 🔴
+
+jobs:
+
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - id: release
+        uses: halvardssm/[email protected]
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          path: "./package.json" # optional, will use ./package.json by default
+
+      - run: |
+          echo 'Release created: ${{steps.release.outputs.release_created}}' # 'true' or 'false'
+          echo 'Release exists: ${{steps.release.outputs.release_exists}}' # 'true' or 'false'
+          echo 'Release tag: ${{steps.release.outputs.release_tag}}' # The tag from package.json
+
+      - name: Notification
+        if: ${{ always() }}
+        uses: appleboy/telegram-action@master
+        with:
+          token: ${{ secrets.BOT_TOKEN }}
+          to: ${{ secrets.CHAT_ID }}
+          message: |
+            Repository: ${{ github.repository }}
+            Release : ${{ env[steps.release.outputs.release_created] }}
+            Tag: ${{ steps.release.outputs.release_tag }}
+
+
+  publish-npm:
+    needs: release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+
+      - name: Notification
+        if: ${{ always() }}
+        uses: appleboy/telegram-action@master
+        with:
+          token: ${{ secrets.BOT_TOKEN }}
+          to: ${{ secrets.CHAT_ID }}
+          message: |
+            Repository: ${{ github.repository }}
+            npm publish : ${{ env[job.status] }}

CHANGELOG.md

@@ -0,0 +1,27 @@
+# 2.0.0
+
+⚠️ BREAKING CHANGE
+
+[@adonisjs/drive](https://docs.adonisjs.com/guides/digging-deeper/drive) is required
+
+***Config basePath is deleted, replace by location option of fs service***
+
+***Refacto getUrl() view helper, [add await](https://github.com/batosai/adonis-attachment?tab=readme-ov-file#urls)***
+
+***Access [serialize](https://github.com/batosai/adonis-attachment?tab=readme-ov-file#by-serialize) is update***
+
+* support @adonisjs/drive
+* dependencies update
+
+# 1.1.0
+
+* variantes videos thumbnail
+
+
+# 1.0.1
+
+* support AdonisJS 6
+* attachment file by file system
+* save meta data
+* variantes images
+* serialize

README.md

@@ -15,11 +15,13 @@ Project sample : [adonis-starter-kit](https://github.com/batosai/adonis-starter-
   - [ ] documents thumbnail
   - [x] videos thumbnail
 - [ ] command regenerate
-- [ ] adonis-drive/flydrive
+- [x] adonis-drive/flydrive
 - [ ] jobs queue
 - [ ] edge component
 - [x] serialize
 
+⚠️ Breaking change [2.0.0 version](https://github.com/batosai/adonis-attachment/blob/main/CHANGELOG.md), include [@adonisjs/drive](https://docs.adonisjs.com/guides/digging-deeper/drive)
+
 ### File sytem
 
 Upload file in public folder.
@@ -42,9 +44,9 @@ Configure differents images sizes and formats
 
 Regenerate variantes files
 
-### Drive (coming soon)
+### Drive
 
-Use drive for private file and cloud services
+Use [@adonisjs/drive](https://docs.adonisjs.com/guides/digging-deeper/drive) for private file and cloud services
 
 ### Jobs queue (coming soon)
 
@@ -55,13 +57,13 @@ Couple with a job queue (recommended, optional)
 Install and configure the package:
 
 ```sh
-node ace add @jrmc/adonis-attachment
+node ace add @jrmc/adonis-attachment@beta
 ```
 
 Or:
 
 ```sh
-npm i @jrmc/adonis-attachment
+npm i @jrmc/adonis-attachment@beta
 node ace configure @jrmc/adonis-attachment
 ```
 
@@ -163,23 +165,41 @@ class User extends BaseModel {
 ## URLs
 
 ```ts
-user.avatar.getUrl()
-user.avatar.getUrl('thumbnail')
+await user.avatar.getUrl()
+await user.avatar.getUrl('thumbnail')
 // or await user.avatar.getVariant('thumbnail').getUrl()
+
+await user.avatar.getSignedUrl()
+await user.avatar.getSignedUrl('thumbnail')
+// or await user.avatar.getVariant('thumbnail').getSignedUrl()
 ```
 
 ```edge
-<img src="{{ user.avatar.getUrl('thumbnail') }}" loading="lazy" alt="" />
+<img src="{{ await user.avatar.getUrl('thumbnail') }}" loading="lazy" alt="" />
+
+<img src="{{ await user.avatar.getSignedUrl() }}" loading="lazy" alt="" />
+<img src="{{ await user.avatar.getSignedUrl({
+  expiresIn: '30 mins',
+}) }}" loading="lazy" alt="" />
+
+<img src="{{ await user.avatar.getSignedUrl('thumbnail') }}" loading="lazy" alt="" />
+<img src="{{ await user.avatar.getSignedUrl('thumbnail', {
+  expiresIn: '30 mins',
+}) }}" loading="lazy" alt="" />
 ```
 
+getSignedUrl options params accepts `expiresIn`, `contentType` et `contentDisposition`. [More informations](https://flydrive.dev/docs/disk_api#getsignedurl)
+
+
 ### by serialize
 
 ```ts
-user.avatar.toJSON()
+await user.avatar.toJSON()
 ```
 
 ```html
-<img :src="user.avatar.thumbnail" loading="lazy" alt="" />
+<img :src="user.avatar.thumbnail.url" loading="lazy" alt="" />
+<img :src="user.avatar.thumbnail.signedUrl" loading="lazy" alt="" />
 ```
 
 ## Configuration
@@ -192,7 +212,6 @@ import app from '@adonisjs/core/services/app'
 import sharp from 'sharp'
 
 export default defineConfig({
-  basePath: app.publicPath(),
   converters: [
     {
       key: 'thumbnail',
@@ -252,6 +271,7 @@ npm install sharp
 ```
 
 Variants thumbnail videos are generate by [fluent-ffmpeg](https://www.npmjs.com/package/fluent-ffmpeg)
+
 By default, image format is PNG and size is video size. `options` attribute use image_converter (and sharp)
 
 ```sh