Roadmap for version 1.0

[RomainLanz]

We are planning to release Flydrive version 1.0 soon. This will be a relatively huge release that include a number of necessary breaking changes.

The code of the release is currently in the next branch.

Planned Feature

• Manager [TypeScript Rewrite] (c71721c)
• LocalFileStorage [TypeScript Rewrite] (cc7bce9)
• Google Cloud Storage Driver (feat: add GoogleCloudStorage driver #81)
• AWSS3 [TypeScript Rewrite] (5f90217)
• Docker Testing for S3/Spaces/Minio and more (Implemented docker-compose testing env #54, 5a6c34d, 6f83ecc)
• Ensure consistency across all drivers (wip: consistency #104)
• Improvement of the documentation
  • Docblocks
  • Method examples
  • Running tests
  • Extending the manager

Nice to have (could wait until after 1.0)

• list(location: string)
• copyToDisk(location: string, dest: string, destDisk: Storage)
• moveToDisk(location: string, dest: string, destDisk: Storage)
• getTimestamp(location: string)

Breaking Changes

No more FTP!

The FTP driver has been removed and will probably not be added again. Feel free to create you own driver and extend the manager with it.

No more proxies!

Proxies have been removed, that means we doesn't support magic method forwarding anymore. You will need to build an abstraction around it (like it's done in the Adonis implementation) if you want to keep this feature.

// Before
storage.exists(...)

// Now
storage.disk().exists(...)

storage.disk() // Returns the default disk (specified in the config)
storage.disk('awsCloud') // Returns the driver for the disk "awsCloud"
storage.disk('awsCloud', customConfig) // Overwrite the default configuration of the disk

Consistent returns/exceptions!

Since all drivers will have a consistent returns you will need to adapt your code to the new interface/abstraction we will create.

A good example is the put method that currently only return a boolean to give you insight if the file as been written or not.

However, some drivers like S3 return many information about the new file (#52). To avoid loosing those information we will create a common response object for those methods that will have always the same properties across all drivers.

If we don't handle a specific use case you will still be able to access the real response by using the raw property.

[RomainLanz]

Premajor 1.0.0-0 has been released!
You can try it with the @next tag on NPM.

[oanhnn]

Does the project have any new update?

[RomainLanz]

We are very close to release!
You can already use the 1.0 version with the @next tag on npm.

[jrbarnard]

Hi @RomainLanz, is there an update on the eta for version 1?
Cheers!

[RomainLanz]

Hey @jrbarnard! 👋

Planned for this week!

[annymosse]

@RomainLanz is this version affect adonis v4 or not ?

[rizalashidiq97]

Is there any update ? I want to extend the manager for google drive

[annymosse]

@rizalashidiq97 there's no need to do that, this version contain google cloud storage already see PR #81