payload 1.0.18 → 1.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,10 @@
|
|
|
1
|
+
## [1.0.19](https://github.com/payloadcms/payload/compare/v1.0.18...v1.0.19) (2022-08-07)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Features
|
|
5
|
+
|
|
6
|
+
* exposes static upload handlers ([a8d2e09](https://github.com/payloadcms/payload/commit/a8d2e099523cc7b99f94ae0cad574b41679c6e25))
|
|
7
|
+
|
|
1
8
|
## [1.0.18](https://github.com/payloadcms/payload/compare/v1.0.17...v1.0.18) (2022-08-06)
|
|
2
9
|
|
|
3
10
|
## [1.0.17](https://github.com/payloadcms/payload/compare/v1.0.16...v1.0.17) (2022-08-06)
|
|
@@ -118,7 +118,8 @@ const collectionSchema = joi_1.default.object().keys({
|
|
|
118
118
|
})),
|
|
119
119
|
mimeTypes: joi_1.default.array().items(joi_1.default.string()),
|
|
120
120
|
staticOptions: joi_1.default.object(),
|
|
121
|
+
handlers: joi_1.default.array().items(joi_1.default.func()),
|
|
121
122
|
}), joi_1.default.boolean()),
|
|
122
123
|
});
|
|
123
124
|
exports.default = collectionSchema;
|
|
124
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
125
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2NoZW1hLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2NvbGxlY3Rpb25zL2NvbmZpZy9zY2hlbWEudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSw4Q0FBc0I7QUFDdEIscUVBQWtFO0FBRWxFLE1BQU0sa0JBQWtCLEdBQUcsYUFBRyxDQUFDLE1BQU0sRUFBRSxDQUFDLElBQUksQ0FBQztJQUMzQyxPQUFPLEVBQUUsYUFBRyxDQUFDLE9BQU8sRUFBRTtJQUN0QixNQUFNLEVBQUUsYUFBRyxDQUFDLE9BQU8sRUFBRTtDQUN0QixDQUFDLENBQUM7QUFFSCxNQUFNLGdCQUFnQixHQUFHLGFBQUcsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxJQUFJLENBQUM7SUFDekMsSUFBSSxFQUFFLGFBQUcsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxRQUFRLEVBQUU7SUFDN0IsTUFBTSxFQUFFLGFBQUcsQ0FBQyxNQUFNLENBQUM7UUFDakIsUUFBUSxFQUFFLGFBQUcsQ0FBQyxNQUFNLEVBQUU7UUFDdEIsTUFBTSxFQUFFLGFBQUcsQ0FBQyxNQUFNLEVBQUU7S0FDckIsQ0FBQztJQUNGLE1BQU0sRUFBRSxhQUFHLENBQUMsTUFBTSxDQUFDO1FBQ2pCLE1BQU0sRUFBRSxhQUFHLENBQUMsSUFBSSxFQUFFO1FBQ2xCLElBQUksRUFBRSxhQUFHLENBQUMsSUFBSSxFQUFFO1FBQ2hCLFlBQVksRUFBRSxhQUFHLENBQUMsSUFBSSxFQUFFO1FBQ3hCLE1BQU0sRUFBRSxhQUFHLENBQUMsSUFBSSxFQUFFO1FBQ2xCLE1BQU0sRUFBRSxhQUFHLENBQUMsSUFBSSxFQUFFO1FBQ2xCLE1BQU0sRUFBRSxhQUFHLENBQUMsSUFBSSxFQUFFO1FBQ2xCLEtBQUssRUFBRSxhQUFHLENBQUMsSUFBSSxFQUFFO0tBQ2xCLENBQUM7SUFDRixVQUFVLEVBQUUsYUFBRyxDQUFDLE9BQU8sRUFBRTtJQUN6QixLQUFLLEVBQUUsYUFBRyxDQUFDLE1BQU0sQ0FBQztRQUNoQixVQUFVLEVBQUUsYUFBRyxDQUFDLE1BQU0sRUFBRTtRQUN4QixjQUFjLEVBQUUsYUFBRyxDQUFDLEtBQUssRUFBRSxDQUFDLEtBQUssQ0FBQyxhQUFHLENBQUMsTUFBTSxFQUFFLENBQUM7UUFDL0MsV0FBVyxFQUFFLGFBQUcsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxHQUFHLENBQ2pDLGFBQUcsQ0FBQyxNQUFNLEVBQUUsRUFDWixpQ0FBZSxDQUNoQjtRQUNELDBCQUEwQixFQUFFLGFBQUcsQ0FBQyxPQUFPLEVBQUU7UUFDekMsVUFBVSxFQUFFLGFBQUcsQ0FBQyxNQUFNLENBQUM7WUFDckIsS0FBSyxFQUFFLGFBQUcsQ0FBQyxNQUFNLENBQUM7Z0JBQ2hCLElBQUksRUFBRSxpQ0FBZTtnQkFDckIsSUFBSSxFQUFFLGlDQUFlO2FBQ3RCLENBQUM7U0FDSCxDQUFDO1FBQ0YsVUFBVSxFQUFFLGFBQUcsQ0FBQyxNQUFNLENBQUM7WUFDckIsWUFBWSxFQUFFLGFBQUcsQ0FBQyxNQUFNLEVBQUU7WUFDMUIsTUFBTSxFQUFFLGFBQUcsQ0FBQyxLQUFLLEVBQUUsQ0FBQyxLQUFLLENBQUMsYUFBRyxDQUFDLE1BQU0sRUFBRSxDQUFDO1NBQ3hDLENBQUM7UUFDRixPQUFPLEVBQUUsYUFBRyxDQUFDLElBQUksRUFBRTtRQUNuQixnQkFBZ0IsRUFBRSxhQUFHLENBQUMsSUFBSSxFQUFFO1FBQzVCLFVBQVUsRUFBRSxhQUFHLENBQUMsSUFBSSxFQUFFO0tBQ3ZCLENBQUM7SUFDRixNQUFNLEVBQUUsYUFBRyxDQUFDLEtBQUssRUFBRTtJQUNuQixLQUFLLEVBQUUsYUFBRyxDQUFDLE1BQU0sQ0FBQztRQUNoQixlQUFlLEVBQUUsYUFBRyxDQUFDLEtBQUssRUFBRSxDQUFDLEtBQUssQ0FBQyxhQUFHLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDOUMsY0FBYyxFQUFFLGFBQUcsQ0FBQyxLQUFLLEVBQUUsQ0FBQyxLQUFLLENBQUMsYUFBRyxDQUFDLElBQUksRUFBRSxDQUFDO1FBQzdDLFlBQVksRUFBRSxhQUFHLENBQUMsS0FBSyxFQUFFLENBQUMsS0FBSyxDQUFDLGFBQUcsQ0FBQyxJQUFJLEVBQUUsQ0FBQztRQUMzQyxXQUFXLEVBQUUsYUFBRyxDQUFDLEtBQUssRUFBRSxDQUFDLEtBQUssQ0FBQyxhQUFHLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDMUMsVUFBVSxFQUFFLGFBQUcsQ0FBQyxLQUFLLEVBQUUsQ0FBQyxLQUFLLENBQUMsYUFBRyxDQUFDLElBQUksRUFBRSxDQUFDO1FBQ3pDLFNBQVMsRUFBRSxhQUFHLENBQUMsS0FBSyxFQUFFLENBQUMsS0FBSyxDQUFDLGFBQUcsQ0FBQyxJQUFJLEVBQUUsQ0FBQztRQUN4QyxZQUFZLEVBQUUsYUFBRyxDQUFDLEtBQUssRUFBRSxDQUFDLEtBQUssQ0FBQyxhQUFHLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDM0MsV0FBVyxFQUFFLGFBQUcsQ0FBQyxLQUFLLEVBQUUsQ0FBQyxLQUFLLENBQUMsYUFBRyxDQUFDLElBQUksRUFBRSxDQUFDO1FBQzFDLFdBQVcsRUFBRSxhQUFHLENBQUMsS0FBSyxFQUFFLENBQUMsS0FBSyxDQUFDLGFBQUcsQ0FBQyxJQUFJLEVBQUUsQ0FBQztRQUMxQyxVQUFVLEVBQUUsYUFBRyxDQUFDLEtBQUssRUFBRSxDQUFDLEtBQUssQ0FBQyxhQUFHLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDekMsV0FBVyxFQUFFLGFBQUcsQ0FBQyxLQUFLLEVBQUUsQ0FBQyxLQUFLLENBQUMsYUFBRyxDQUFDLElBQUksRUFBRSxDQUFDO1FBQzFDLE9BQU8sRUFBRSxhQUFHLENBQUMsS0FBSyxFQUFFLENBQUMsS0FBSyxDQUFDLGFBQUcsQ0FBQyxJQUFJLEVBQUUsQ0FBQztRQUN0QyxZQUFZLEVBQUUsYUFBRyxDQUFDLEtBQUssRUFBRSxDQUFDLEtBQUssQ0FBQyxhQUFHLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDM0MsbUJBQW1CLEVBQUUsYUFBRyxDQUFDLEtBQUssRUFBRSxDQUFDLEtBQUssQ0FBQyxhQUFHLENBQUMsSUFBSSxFQUFFLENBQUM7S0FDbkQsQ0FBQztJQUNGLFNBQVMsRUFBRSxhQUFHLENBQUMsS0FBSyxFQUFFLENBQUMsS0FBSyxDQUFDLGFBQUcsQ0FBQyxNQUFNLENBQUM7UUFDdEMsSUFBSSxFQUFFLGFBQUcsQ0FBQyxNQUFNLEVBQUU7UUFDbEIsTUFBTSxFQUFFLGFBQUcsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxLQUFLLENBQUMsS0FBSyxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUUsS0FBSyxFQUFFLE9BQU8sRUFBRSxRQUFRLEVBQUUsU0FBUyxFQUFFLFNBQVMsQ0FBQztRQUNqRyxPQUFPLEVBQUUsYUFBRyxDQUFDLFlBQVksRUFBRSxDQUFDLEdBQUcsQ0FDN0IsYUFBRyxDQUFDLEtBQUssRUFBRSxDQUFDLEtBQUssQ0FBQyxhQUFHLENBQUMsSUFBSSxFQUFFLENBQUMsRUFDN0IsYUFBRyxDQUFDLElBQUksRUFBRSxDQUNYO0tBQ0YsQ0FBQyxDQUFDO0lBQ0gsSUFBSSxFQUFFLGFBQUcsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxHQUFHLENBQzFCLGFBQUcsQ0FBQyxNQUFNLENBQUM7UUFDVCxlQUFlLEVBQUUsYUFBRyxDQUFDLE1BQU0sRUFBRTtRQUM3QixLQUFLLEVBQUUsYUFBRyxDQUFDLE1BQU0sRUFBRTtRQUNuQixNQUFNLEVBQUUsYUFBRyxDQUFDLFlBQVksRUFBRSxDQUFDLEdBQUcsQ0FDNUIsYUFBRyxDQUFDLE9BQU8sRUFBRSxFQUNiLGFBQUcsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxJQUFJLENBQUM7WUFDaEIsaUJBQWlCLEVBQUUsYUFBRyxDQUFDLElBQUksRUFBRTtZQUM3QixvQkFBb0IsRUFBRSxhQUFHLENBQUMsSUFBSSxFQUFFO1NBQ2pDLENBQUMsQ0FDSDtRQUNELFFBQVEsRUFBRSxhQUFHLENBQUMsTUFBTSxFQUFFO1FBQ3RCLFNBQVMsRUFBRSxhQUFHLENBQUMsT0FBTyxFQUFFO1FBQ3hCLE9BQU8sRUFBRSxhQUFHLENBQUMsTUFBTSxFQUFFLENBQUMsSUFBSSxDQUFDO1lBQ3pCLE1BQU0sRUFBRSxhQUFHLENBQUMsT0FBTyxFQUFFO1lBQ3JCLFFBQVEsRUFBRSxhQUFHLENBQUMsTUFBTSxFQUFFO1lBQ3RCLE1BQU0sRUFBRSxhQUFHLENBQUMsTUFBTSxFQUFFO1NBQ3JCLENBQUM7UUFDRixjQUFjLEVBQUUsYUFBRyxDQUFDLE1BQU0sRUFBRSxDQUFDLElBQUksQ0FBQztZQUNoQyxpQkFBaUIsRUFBRSxhQUFHLENBQUMsSUFBSSxFQUFFO1lBQzdCLG9CQUFvQixFQUFFLGFBQUcsQ0FBQyxJQUFJLEVBQUU7U0FDakMsQ0FBQztRQUNGLGdCQUFnQixFQUFFLGFBQUcsQ0FBQyxNQUFNLEVBQUU7UUFDOUIsb0JBQW9CLEVBQUUsYUFBRyxDQUFDLE9BQU8sRUFBRSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUM7UUFDL0MsVUFBVSxFQUFFLGFBQUcsQ0FBQyxLQUFLLEVBQUUsQ0FBQyxLQUFLLENBQUMsYUFBRyxDQUFDLFlBQVksRUFBRSxDQUFDLEdBQUcsQ0FDbEQsa0JBQWtCLENBQUMsSUFBSSxDQUFDO1lBQ3RCLElBQUksRUFBRSxhQUFHLENBQUMsTUFBTSxFQUFFLENBQUMsUUFBUSxFQUFFO1lBQzdCLFFBQVEsRUFBRSxhQUFHLENBQUMsSUFBSSxFQUFFO2lCQUNqQixRQUFRLENBQUMsQ0FBQyxDQUFDO2lCQUNYLFFBQVEsRUFBRTtTQUNkLENBQUMsRUFDRixrQkFBa0IsQ0FBQyxJQUFJLENBQUM7WUFDdEIsSUFBSSxFQUFFLGFBQUcsQ0FBQyxNQUFNLEVBQUU7WUFDbEIsUUFBUSxFQUFFLGFBQUcsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxRQUFRLEVBQUU7U0FDbEMsQ0FBQyxDQUNILENBQUM7S0FDSCxDQUFDLEVBQ0YsYUFBRyxDQUFDLE9BQU8sRUFBRSxDQUNkO0lBQ0QsUUFBUSxFQUFFLGFBQUcsQ0FBQyxZQUFZLEVBQUUsQ0FBQyxHQUFHLENBQzlCLGFBQUcsQ0FBQyxNQUFNLENBQUM7UUFDVCxTQUFTLEVBQUUsYUFBRyxDQUFDLE1BQU0sRUFBRTtRQUN2QixhQUFhLEVBQUUsYUFBRyxDQUFDLE9BQU8sRUFBRTtRQUM1QixNQUFNLEVBQUUsYUFBRyxDQUFDLFlBQVksRUFBRSxDQUFDLEdBQUcsQ0FDNUIsYUFBRyxDQUFDLE1BQU0sQ0FBQztZQUNULFFBQVEsRUFBRSxhQUFHLENBQUMsWUFBWSxFQUFFLENBQUMsR0FBRyxDQUM5QixhQUFHLENBQUMsT0FBTyxFQUFFLEVBQ2IsYUFBRyxDQUFDLE1BQU0sQ0FBQztnQkFDVCxRQUFRLEVBQUUsYUFBRyxDQUFDLE1BQU0sRUFBRTthQUN2QixDQUFDLENBQ0g7U0FDRixDQUFDLEVBQ0YsYUFBRyxDQUFDLE9BQU8sRUFBRSxDQUNkO0tBQ0YsQ0FBQyxFQUNGLGFBQUcsQ0FBQyxPQUFPLEVBQUUsQ0FDZDtJQUNELE1BQU0sRUFBRSxhQUFHLENBQUMsWUFBWSxFQUFFLENBQUMsR0FBRyxDQUM1QixhQUFHLENBQUMsTUFBTSxDQUFDO1FBQ1QsU0FBUyxFQUFFLGFBQUcsQ0FBQyxNQUFNLEVBQUU7UUFDdkIsU0FBUyxFQUFFLGFBQUcsQ0FBQyxNQUFNLEVBQUU7UUFDdkIsbUJBQW1CLEVBQUUsYUFBRyxDQUFDLElBQUksRUFBRTtRQUMvQixjQUFjLEVBQUUsYUFBRyxDQUFDLFlBQVksRUFBRSxDQUFDLEdBQUcsQ0FDcEMsYUFBRyxDQUFDLE1BQU0sRUFBRSxFQUNaLGFBQUcsQ0FBQyxJQUFJLEVBQUUsQ0FDWDtRQUNELFVBQVUsRUFBRSxhQUFHLENBQUMsS0FBSyxFQUFFLENBQUMsS0FBSyxDQUMzQixhQUFHLENBQUMsTUFBTSxFQUFFLENBQUMsSUFBSSxDQUFDO1lBQ2hCLElBQUksRUFBRSxhQUFHLENBQUMsTUFBTSxFQUFFO1lBQ2xCLEtBQUssRUFBRSxhQUFHLENBQUMsTUFBTSxFQUFFLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQztZQUMvQixNQUFNLEVBQUUsYUFBRyxDQUFDLE1BQU0sRUFBRSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUM7WUFDaEMsSUFBSSxFQUFFLGFBQUcsQ0FBQyxNQUFNLEVBQUUsRUFBRSw2Q0FBNkM7U0FDbEUsQ0FBQyxDQUNIO1FBQ0QsU0FBUyxFQUFFLGFBQUcsQ0FBQyxLQUFLLEVBQUUsQ0FBQyxLQUFLLENBQUMsYUFBRyxDQUFDLE1BQU0sRUFBRSxDQUFDO1FBQzFDLGFBQWEsRUFBRSxhQUFHLENBQUMsTUFBTSxFQUFFO1FBQzNCLFFBQVEsRUFBRSxhQUFHLENBQUMsS0FBSyxFQUFFLENBQUMsS0FBSyxDQUFDLGFBQUcsQ0FBQyxJQUFJLEVBQUUsQ0FBQztLQUN4QyxDQUFDLEVBQ0YsYUFBRyxDQUFDLE9BQU8sRUFBRSxDQUNkO0NBQ0YsQ0FBQyxDQUFDO0FBRUgsa0JBQWUsZ0JBQWdCLENBQUMifQ==
|
package/dist/express/static.js
CHANGED
|
@@ -11,6 +11,7 @@ const authenticate_1 = __importDefault(require("./middleware/authenticate"));
|
|
|
11
11
|
const corsHeaders_1 = __importDefault(require("./middleware/corsHeaders"));
|
|
12
12
|
function initStatic(ctx) {
|
|
13
13
|
Object.entries(ctx.collections).forEach(([_, collection]) => {
|
|
14
|
+
var _a;
|
|
14
15
|
const { config } = collection;
|
|
15
16
|
if (config.upload) {
|
|
16
17
|
const router = express_1.default.Router();
|
|
@@ -18,6 +19,9 @@ function initStatic(ctx) {
|
|
|
18
19
|
router.use(passport_1.default.initialize());
|
|
19
20
|
router.use((0, authenticate_1.default)(ctx.config));
|
|
20
21
|
router.use((0, getExecuteStaticAccess_1.default)(collection));
|
|
22
|
+
if (Array.isArray((_a = config.upload) === null || _a === void 0 ? void 0 : _a.handlers)) {
|
|
23
|
+
router.get('/:filename*', config.upload.handlers);
|
|
24
|
+
}
|
|
21
25
|
const staticPath = path_1.default.resolve(ctx.config.paths.configDir, config.upload.staticDir);
|
|
22
26
|
router.use(express_1.default.static(staticPath, config.upload.staticOptions || {}));
|
|
23
27
|
ctx.express.use(`${config.upload.staticURL}`, router);
|
|
@@ -25,4 +29,4 @@ function initStatic(ctx) {
|
|
|
25
29
|
});
|
|
26
30
|
}
|
|
27
31
|
exports.default = initStatic;
|
|
28
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
32
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RhdGljLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2V4cHJlc3Mvc3RhdGljLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsc0RBQThCO0FBQzlCLHdEQUFnQztBQUNoQyxnREFBd0I7QUFDeEIsNEZBQW9FO0FBQ3BFLDZFQUFxRDtBQUVyRCwyRUFBbUQ7QUFFbkQsU0FBUyxVQUFVLENBQUMsR0FBWTtJQUM5QixNQUFNLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxXQUFXLENBQUMsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLENBQUMsRUFBRSxVQUFVLENBQUMsRUFBRSxFQUFFOztRQUMxRCxNQUFNLEVBQUUsTUFBTSxFQUFFLEdBQUcsVUFBVSxDQUFDO1FBRTlCLElBQUksTUFBTSxDQUFDLE1BQU0sRUFBRTtZQUNqQixNQUFNLE1BQU0sR0FBRyxpQkFBTyxDQUFDLE1BQU0sRUFBRSxDQUFDO1lBRWhDLE1BQU0sQ0FBQyxHQUFHLENBQUMsSUFBQSxxQkFBVyxFQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDO1lBQ3BDLE1BQU0sQ0FBQyxHQUFHLENBQUMsa0JBQVEsQ0FBQyxVQUFVLEVBQUUsQ0FBQyxDQUFDO1lBQ2xDLE1BQU0sQ0FBQyxHQUFHLENBQUMsSUFBQSxzQkFBWSxFQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDO1lBRXJDLE1BQU0sQ0FBQyxHQUFHLENBQUMsSUFBQSxnQ0FBc0IsRUFBQyxVQUFVLENBQUMsQ0FBQyxDQUFDO1lBRS9DLElBQUksS0FBSyxDQUFDLE9BQU8sQ0FBQyxNQUFBLE1BQU0sQ0FBQyxNQUFNLDBDQUFFLFFBQVEsQ0FBQyxFQUFFO2dCQUMxQyxNQUFNLENBQUMsR0FBRyxDQUFDLGFBQWEsRUFBRSxNQUFNLENBQUMsTUFBTSxDQUFDLFFBQVEsQ0FBQyxDQUFDO2FBQ25EO1lBRUQsTUFBTSxVQUFVLEdBQUcsY0FBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxTQUFTLEVBQUUsTUFBTSxDQUFDLE1BQU0sQ0FBQyxTQUFTLENBQUMsQ0FBQztZQUVyRixNQUFNLENBQUMsR0FBRyxDQUFDLGlCQUFPLENBQUMsTUFBTSxDQUFDLFVBQVUsRUFBRSxNQUFNLENBQUMsTUFBTSxDQUFDLGFBQWEsSUFBSSxFQUFFLENBQUMsQ0FBQyxDQUFDO1lBRTFFLEdBQUcsQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQyxTQUFTLEVBQUUsRUFBRSxNQUFNLENBQUMsQ0FBQztTQUN2RDtJQUNILENBQUMsQ0FBQyxDQUFDO0FBQ0wsQ0FBQztBQUVELGtCQUFlLFVBQVUsQ0FBQyJ9
|
package/dist/uploads/types.d.ts
CHANGED
|
@@ -38,6 +38,7 @@ export declare type IncomingUploadType = {
|
|
|
38
38
|
adminThumbnail?: string | GetAdminThumbnail;
|
|
39
39
|
mimeTypes?: string[];
|
|
40
40
|
staticOptions?: serveStatic.ServeStaticOptions<express.Response<any, Record<string, any>>>;
|
|
41
|
+
handlers?: any[];
|
|
41
42
|
};
|
|
42
43
|
export declare type Upload = {
|
|
43
44
|
imageSizes?: ImageSize[];
|
|
@@ -47,6 +48,7 @@ export declare type Upload = {
|
|
|
47
48
|
adminThumbnail?: string | GetAdminThumbnail;
|
|
48
49
|
mimeTypes?: string[];
|
|
49
50
|
staticOptions?: serveStatic.ServeStaticOptions<express.Response<any, Record<string, any>>>;
|
|
51
|
+
handlers?: any[];
|
|
50
52
|
};
|
|
51
53
|
export declare type File = {
|
|
52
54
|
data: Buffer;
|
package/docs/upload/overview.mdx
CHANGED
|
@@ -7,11 +7,13 @@ keywords: uploads, images, media, overview, documentation, Content Management Sy
|
|
|
7
7
|
---
|
|
8
8
|
|
|
9
9
|
<Banner>
|
|
10
|
-
Payload provides for everything you need to enable file upload, storage, and
|
|
10
|
+
Payload provides for everything you need to enable file upload, storage, and
|
|
11
|
+
management directly on your server—including extremely powerful file access
|
|
12
|
+
control.
|
|
11
13
|
</Banner>
|
|
12
14
|
|
|
13
15
|
|
|
14
|
-
|
|
16
|
+
_Admin panel screenshot depicting a Media Collection with Upload enabled_
|
|
15
17
|
|
|
16
18
|
**Here are some common use cases of Uploads:**
|
|
17
19
|
|
|
@@ -22,7 +24,7 @@ keywords: uploads, images, media, overview, documentation, Content Management Sy
|
|
|
22
24
|
**By simply enabling Upload functionality on a Collection, Payload will automatically transform your Collection into a robust file management / storage solution. The following modifications will be made:**
|
|
23
25
|
|
|
24
26
|
1. `filename`, `mimeType`, and `filesize` fields will be automatically added to your Collection. Optionally, if you pass `imageSizes` to your Collection's Upload config, a [`sizes`](#image-sizes) array will also be added containing auto-resized image sizes and filenames.
|
|
25
|
-
1.
|
|
27
|
+
1. The Admin panel will modify its built-in `List` component to show a thumbnail gallery of your Uploads instead of the default Table view
|
|
26
28
|
1. The Admin panel will modify its `Edit` view(s) to add a new set of corresponding Upload UI which will allow for file upload
|
|
27
29
|
1. The `create`, `update`, and `delete` Collection operations will be modified to support file upload, re-upload, and deletion
|
|
28
30
|
|
|
@@ -31,59 +33,62 @@ keywords: uploads, images, media, overview, documentation, Content Management Sy
|
|
|
31
33
|
Every Payload Collection can opt-in to supporting Uploads by specifying the `upload` property on the Collection's config to either `true` or to an object containing `upload` options.
|
|
32
34
|
|
|
33
35
|
<Banner type="success">
|
|
34
|
-
<strong>Tip:</strong
|
|
35
|
-
A common pattern is to create a <strong>Media</strong> collection and enable
|
|
36
|
+
<strong>Tip:</strong>
|
|
37
|
+
<br />A common pattern is to create a <strong>Media</strong> collection and enable{" "}
|
|
38
|
+
<strong>upload</strong> on that collection.
|
|
36
39
|
</Banner>
|
|
37
40
|
|
|
38
41
|
#### Collection Upload Options
|
|
39
42
|
|
|
40
|
-
| Option | Description
|
|
41
|
-
| ------------------------- |
|
|
42
|
-
| **`staticURL`**
|
|
43
|
-
| **`staticDir`**
|
|
44
|
-
| **`imageSizes`** | If specified, image uploads will be automatically resized in accordance to these image sizes. [More](#image-sizes)
|
|
45
|
-
| **`adminThumbnail`** | Set the way that the Admin panel will display thumbnails for this Collection. [More](#admin-thumbnails)
|
|
46
|
-
| **`mimeTypes`** | Restrict mimeTypes in the file picker. Array of valid mimetypes or mimetype wildcards [More](#mimetypes)
|
|
47
|
-
| **`disableLocalStorage`** | Completely disable uploading files to disk locally. [More](#disabling-local-upload-storage)
|
|
43
|
+
| Option | Description |
|
|
44
|
+
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
45
|
+
| **`staticURL`** \* | The base URL path to use to access your uploads. Example: `/media` |
|
|
46
|
+
| **`staticDir`** \* | The folder directory to use to store media in. Can be either an absolute path or relative to the directory that contains your config. |
|
|
47
|
+
| **`imageSizes`** | If specified, image uploads will be automatically resized in accordance to these image sizes. [More](#image-sizes) |
|
|
48
|
+
| **`adminThumbnail`** | Set the way that the Admin panel will display thumbnails for this Collection. [More](#admin-thumbnails) |
|
|
49
|
+
| **`mimeTypes`** | Restrict mimeTypes in the file picker. Array of valid mimetypes or mimetype wildcards [More](#mimetypes) |
|
|
50
|
+
| **`disableLocalStorage`** | Completely disable uploading files to disk locally. [More](#disabling-local-upload-storage) |
|
|
48
51
|
| **`staticOptions`** | Set options for `express.static` to use while serving your static files. [More](http://expressjs.com/en/resources/middleware/serve-static.html) |
|
|
52
|
+
| **`handlers`** | Array of Express request handlers to execute before the built-in Payload static middleware executes. |
|
|
49
53
|
|
|
50
|
-
|
|
54
|
+
_An asterisk denotes that a property above is required._
|
|
51
55
|
|
|
52
56
|
**Example Upload collection:**
|
|
57
|
+
|
|
53
58
|
```js
|
|
54
59
|
const Media = {
|
|
55
|
-
slug:
|
|
60
|
+
slug: "media",
|
|
56
61
|
upload: {
|
|
57
|
-
staticURL:
|
|
58
|
-
staticDir:
|
|
62
|
+
staticURL: "/media",
|
|
63
|
+
staticDir: "media",
|
|
59
64
|
imageSizes: [
|
|
60
65
|
{
|
|
61
|
-
name:
|
|
66
|
+
name: "thumbnail",
|
|
62
67
|
width: 400,
|
|
63
68
|
height: 300,
|
|
64
|
-
crop:
|
|
69
|
+
crop: "centre",
|
|
65
70
|
},
|
|
66
71
|
{
|
|
67
|
-
name:
|
|
72
|
+
name: "card",
|
|
68
73
|
width: 768,
|
|
69
74
|
height: 1024,
|
|
70
|
-
crop:
|
|
75
|
+
crop: "centre",
|
|
71
76
|
},
|
|
72
77
|
{
|
|
73
|
-
name:
|
|
78
|
+
name: "tablet",
|
|
74
79
|
width: 1024,
|
|
75
80
|
// By specifying `null` or leaving a height undefined,
|
|
76
81
|
// the image will be sized to a certain width,
|
|
77
82
|
// but it will retain its original aspect ratio
|
|
78
83
|
// and calculate a height automatically.
|
|
79
84
|
height: null,
|
|
80
|
-
crop:
|
|
81
|
-
}
|
|
85
|
+
crop: "centre",
|
|
86
|
+
},
|
|
82
87
|
],
|
|
83
|
-
adminThumbnail:
|
|
84
|
-
mimeTypes: [
|
|
85
|
-
}
|
|
86
|
-
}
|
|
88
|
+
adminThumbnail: "thumbnail",
|
|
89
|
+
mimeTypes: ["image/*"],
|
|
90
|
+
},
|
|
91
|
+
};
|
|
87
92
|
```
|
|
88
93
|
|
|
89
94
|
### Payload-wide Upload Options
|
|
@@ -93,16 +98,16 @@ Payload relies on the [`express-fileupload`](https://www.npmjs.com/package/expre
|
|
|
93
98
|
A common example of what you might want to customize within Payload-wide Upload options would be to increase the allowed `fileSize` of uploads sent to Payload:
|
|
94
99
|
|
|
95
100
|
```js
|
|
96
|
-
import { buildConfig } from
|
|
101
|
+
import { buildConfig } from "payload/config";
|
|
97
102
|
|
|
98
103
|
export default buildConfig({
|
|
99
104
|
collections: [
|
|
100
105
|
{
|
|
101
|
-
slug:
|
|
106
|
+
slug: "media",
|
|
102
107
|
fields: [
|
|
103
108
|
{
|
|
104
|
-
name:
|
|
105
|
-
type:
|
|
109
|
+
name: "alt",
|
|
110
|
+
type: "text",
|
|
106
111
|
},
|
|
107
112
|
],
|
|
108
113
|
upload: true,
|
|
@@ -111,8 +116,8 @@ export default buildConfig({
|
|
|
111
116
|
upload: {
|
|
112
117
|
limits: {
|
|
113
118
|
fileSize: 5000000, // 5MB, written in bytes
|
|
114
|
-
}
|
|
115
|
-
}
|
|
119
|
+
},
|
|
120
|
+
},
|
|
116
121
|
});
|
|
117
122
|
```
|
|
118
123
|
|
|
@@ -135,8 +140,13 @@ The object will have keys for each size generated, and each key will be set equa
|
|
|
135
140
|
If you are using a plugin to send your files off to a third-party file storage host or CDN, like Amazon S3 or similar, you may not want to store your files locally at all. You can prevent Payload from writing files to disk by specifying `disableLocalStorage: true` on your collection's upload config.
|
|
136
141
|
|
|
137
142
|
<Banner type="warning">
|
|
138
|
-
<strong>Note:</strong
|
|
139
|
-
|
|
143
|
+
<strong>Note:</strong>
|
|
144
|
+
<br />
|
|
145
|
+
This is a fairly advanced feature. If you do disable local file storage, by
|
|
146
|
+
default, your admin panel's thumbnails will be broken as you will not have
|
|
147
|
+
stored a file. It will be totally up to you to use either a plugin or your own
|
|
148
|
+
hooks to store your files in a permanent manner, as well as provide your own
|
|
149
|
+
admin thumbnail using <strong>upload.adminThumbnail</strong>.
|
|
140
150
|
</Banner>
|
|
141
151
|
|
|
142
152
|
### Admin Thumbnails
|
|
@@ -147,12 +157,13 @@ You can specify how Payload retrieves admin thumbnails for your upload-enabled C
|
|
|
147
157
|
1. A function that takes the document's data and sends back a full URL to load the thumbnail. For example, to dynamically set an admin thumbnail URL, you could write a function that returns a string pointing to a different file source:
|
|
148
158
|
|
|
149
159
|
**Example custom Admin thumbnail:**
|
|
160
|
+
|
|
150
161
|
```js
|
|
151
162
|
const Media = {
|
|
152
|
-
slug:
|
|
163
|
+
slug: "media",
|
|
153
164
|
upload: {
|
|
154
|
-
staticURL:
|
|
155
|
-
staticDir:
|
|
165
|
+
staticURL: "/media",
|
|
166
|
+
staticDir: "media",
|
|
156
167
|
imageSizes: [
|
|
157
168
|
// ... image sizes here
|
|
158
169
|
],
|
|
@@ -160,13 +171,16 @@ const Media = {
|
|
|
160
171
|
adminThumbnail: ({ doc }) =>
|
|
161
172
|
`https://google.com/custom-path-to-file/${doc.filename}`,
|
|
162
173
|
// highlight-end
|
|
163
|
-
}
|
|
164
|
-
}
|
|
174
|
+
},
|
|
175
|
+
};
|
|
165
176
|
```
|
|
166
177
|
|
|
167
178
|
<Banner>
|
|
168
|
-
<strong>Note:</strong
|
|
169
|
-
|
|
179
|
+
<strong>Note:</strong>
|
|
180
|
+
<br />
|
|
181
|
+
If you specify a function to return an admin thumbnail, but your upload is not
|
|
182
|
+
an image file type (for example, PDF or TXT) your function will not be used.
|
|
183
|
+
Instead, Payload will display its generic file upload graphic.
|
|
170
184
|
</Banner>
|
|
171
185
|
|
|
172
186
|
### MimeTypes
|
|
@@ -176,22 +190,26 @@ Specifying the `mimeTypes` property can restrict what files are allowed from the
|
|
|
176
190
|
Some example values are: `image/*`, `audio/*`, `video/*`, `image/png`, `application/pdf`
|
|
177
191
|
|
|
178
192
|
**Example mimeTypes usage:**
|
|
193
|
+
|
|
179
194
|
```js
|
|
180
195
|
const Media = {
|
|
181
|
-
slug:
|
|
196
|
+
slug: "media",
|
|
182
197
|
upload: {
|
|
183
|
-
staticURL:
|
|
184
|
-
staticDir:
|
|
185
|
-
mimeTypes: [
|
|
186
|
-
}
|
|
187
|
-
}
|
|
198
|
+
staticURL: "/media",
|
|
199
|
+
staticDir: "media",
|
|
200
|
+
mimeTypes: ["image/*", "application/pdf"], // highlight-line
|
|
201
|
+
},
|
|
202
|
+
};
|
|
188
203
|
```
|
|
189
204
|
|
|
190
205
|
### Uploading Files
|
|
191
206
|
|
|
192
207
|
<Banner type="warning">
|
|
193
|
-
<strong>Important:</strong
|
|
194
|
-
|
|
208
|
+
<strong>Important:</strong>
|
|
209
|
+
<br />
|
|
210
|
+
Uploading files is currently only possible through the REST and Local APIs due
|
|
211
|
+
to how GraphQL works. It's difficult and fairly nonsensical to support
|
|
212
|
+
uploading files through GraphQL.
|
|
195
213
|
</Banner>
|
|
196
214
|
|
|
197
215
|
To upload a file, use your collection's [`create`](/docs/rest-api/overview#collections) endpoint. Send it all the data that your Collection requires, as well as a `file` key containing the file that you'd like to upload.
|