1+ /**
2+ * Plugin Interface Documentation
3+ *
4+ * This file documents the expected structure for UploadInterceptor plugins.
5+ * Plugins should export an object with the following structure:
6+ */
7+
8+ /**
9+ * Example plugin structure:
10+ *
11+ * export default {
12+ * name: 'ExamplePlugin',
13+ *
14+ * hooks: {
15+ * // Called before upload starts
16+ * beforeUpload: (uploadItem) => {
17+ * console.log('Upload starting for:', uploadItem._label);
18+ * },
19+ *
20+ * // Called when upload status changes
21+ * onStatusChange: (uploadItem, status) => {
22+ * console.log('Upload status changed to:', status);
23+ * },
24+ *
25+ * // Called when upload completes successfully
26+ * onUploadComplete: (uploadItem) => {
27+ * console.log('Upload completed for:', uploadItem._label);
28+ * },
29+ *
30+ * // Called when upload encounters an error
31+ * onUploadError: (uploadItem) => {
32+ * console.error('Upload failed for:', uploadItem._label);
33+ * }
34+ * }
35+ * };
36+ */
37+
38+ /**
39+ * Available uploadItem properties (from UploaderModel.UploadItem):
40+ * - _file: The File object being uploaded
41+ * - _label: Display name of the file
42+ * - _targetNode: Destination node information
43+ * - _observers: Observer system for status changes
44+ * - Plus other Pydio-specific properties
45+ */
46+
47+ /**
48+ * Hook execution order:
49+ * 1. beforeUpload - Called immediately when upload starts
50+ * 2. onStatusChange - Called for each status change during upload
51+ * 3. onUploadComplete OR onUploadError - Called when upload finishes
52+ */
53+
54+ export default {
55+ // This file is for documentation only
56+ // Actual plugins should be in the plugins/ directory
57+ } ;
0 commit comments