refactor!: rewrite storage system - Githubissues

unjs / ipx

🖼️ High performance, secure and easy-to-use image optimizer.

MIT License

1.87k stars 63 forks source link

refactor!: rewrite storage system #164

Closed pi0 closed 1 year ago

pi0 commented 1 year ago

🔗 Linked issue

❓ Type of change

[ ] 📖 Documentation (updates to the documentation, readme, or JSdoc annotations)
[ ] 🐞 Bug fix (a non-breaking change that fixes an issue)
[ ] 👌 Enhancement (improving an existing functionality like performance)
[ ] ✨ New feature (a non-breaking change that adds functionality)
[ ] 🧹 Chore (updates to the build process or auxiliary tools and libraries)
[ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

This PR rewrites ipx storage API for two goals:

Easier unjs/unstorage compatibility
Remove Node.js dependency (only keep as opt-in)

Configuration migration:

++ import { ipxFSStorage, ipxHttpStorage } from "ipx";
--  dir: "./images",
--  domains: ["http://localhost:3000"],
++ storage: ipxFSStorage({ dir: "./images" }),
++ httpStorage: ipxHttpStorage({ domains: ["localhost:3000"] })

Testing:

pnpm dev

http://localhost:3000/w_800/bliss.jpg

http://localhost:3000/rotate_25/https://picsum.photos/500/500

📝 Checklist

[ ] I have linked an issue or discussion.
[ ] I have updated the documentation accordingly.

pi0 commented 1 year ago

More changes need to be on top of this but i guess better to iterate in main and have smaller changelogs for next steps.