@universal-packages/express-controllers-storage
v1.4.14
Published
universal-storage implementation on top of universal-express-controllers.
Downloads
767
Readme
Express Controllers Storage
universal-storage implementation on top of universal-express-controllers
Install
npm install @universal-packages/express-controllers-storage
npm install @universal-packages/express-controllers
Global methods
initialize(options: Object, [authenticatableClass: AuthenticatableClass])
Initialize the storage api and the storage controller to prepare routing configuration before the ExpressControllers
runs. The storage controller is loaded automatically by ExpressControllers
.
import { initialize } from '@universal-packages/express-controllers-storage'
import { ExpressControllers } from '@universal-packages/express-controllers'
import User from './User'
await initialize({ dynamicsLocation: './src' }, User)
const app = new ExpressControllers({ port: 3000 })
await app.prepare()
await app.run()
Now storage blobs a re being served in storage/:key/:filename
Options
initialize()
takes the same options as Storage
.
Additionally takes the following ones:
rootPath
String
default: /storage
You can set the root of all storage routes, ex:/files
urlHost
String
default: 'http://localhost'
You can set the host to generate urls for the controller actions url generators.routes
retrieve
enable
Boolean
default: true
Enables the controller to expose this actionpath
String
default: /:key/:filename
Enables the customization of the route for this actionmethod
HTTPVerb
default: GET
Lets customize the method to access this action
debug
Boolean
default: false
Enables the debug mode for the dynamics.dynamicsLocation
String
The location of the dynamics.externalStrategy
redirect | proxy
default: redirect
The strategy to use for external urls generated by Storage, redirect to the service or proxy the data stream.
getKeyUrl(key: string, filename: string)
Returns the url for the retrieve
action of the storage controller to access the given key. Based on urlHost
, rootPath
, retrieve
route options.
getKeyVersionUrl(key: string, filename: string, descriptor: Object)
descriptor
VersionBlobDescriptor
width
Number
height
Number
fit
contain | cover | fill | inside | outside
Returns the url for the retrieve
action of the storage controller to access the given key and version. Based on urlHost
, rootPath
, retrieve
route options.
Dynamics
If you need to allow blobs depending on different conditions, you can override dynamic should-allow-access-blob
and return true
or false
depending on your conditions.
import { Dynamic } from '@universal-packages/dynamic-api'
@Dynamic('should-allow-access-blob')
export default class ShouldAllowAccessBlobDynamic {
async perform(payload): Promise<boolean> {
const { request, key } = payload
const currentUser = request.currentUser
if (currentUser.canAccess(key)) {
return true
}
return false
}
}
Typescript
This library is developed in TypeScript and shipped fully typed.
Contributing
The development of this library happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.